AppleTunneler/README.md

43 lines
2.0 KiB
Markdown
Raw Normal View History

2022-03-22 12:47:34 +00:00
# Warning
before using the plugin those steps were made on a linux machine not sure about windows
but those might work on any unix system like bsd or freebsd
2022-07-09 12:46:47 +00:00
And also this was made for shared hosting only, not meant on dedicated as you control the operating system
2022-03-22 12:47:34 +00:00
2022-03-22 12:48:42 +00:00
# How to setup on |*ssh server in linux*|
2022-02-04 05:27:17 +00:00
* create user in your system using the command provided below
2022-08-30 17:55:10 +00:00
``useradd appletunnel --shell=/bin/true``
2022-02-04 05:27:39 +00:00
2022-02-04 05:27:17 +00:00
this will make the user have no shell + sftp and scp access.
2022-02-04 05:13:08 +00:00
2022-08-30 17:55:10 +00:00
* Create SSH key for the user:
- Login into the created user
- Execute `ssh-keygen`
- Leave the passphrase empty during ssh key creation
- Append ~/.ssh/id_rsa.pub contents to ~/.ssh/authorized_keys file, if authorized_keys file does not exist, create it
2022-02-04 05:13:08 +00:00
2022-02-04 05:27:17 +00:00
* there will be issue that user can't login to fix this
2022-02-04 05:24:33 +00:00
add ``/bin/true`` to ``/etc/shells``
* start your minecraft server with the plugin installed.
but you will notice that it will not load the plugins as shown down below.
```
[09:16:17 WARN]: [AppleTunneler] no Identities files found, please put them in plugins/AppleTunneler/Identities
[09:16:17 ERROR]: Error occurred while enabling AppleTunneler v1.0-SNAPSHOT (Is it up to date?)
```
2022-08-30 17:55:10 +00:00
* put your created user's private key in ``plugins/AppleTunneler/Identities`` folder
2022-02-04 05:24:33 +00:00
2022-02-04 05:25:49 +00:00
* start server again, but you will be met with another error as shown below
2022-02-04 05:24:33 +00:00
```
[09:20:16 ERROR]: [AppleTunneler] FILE at path: /home/test/Desktop/test-server/plugins/AppleTunneler/.known_hosts Does not exists
[09:20:16 ERROR]: Error occurred while enabling AppleTunneler v1.0-SNAPSHOT (Is it up to date?)
java.lang.RuntimeException: Known host file does not exists in plugin folder
```
as you can see the error created path for us which will be easy for us to create the file, now copy the path.
* run this command to create the host file
``ssh-keyscan limework.net >> /home/test/Desktop/test-server/plugins/AppleTunneler/.known_hosts``
* now modify the config of the plugins for your needs by setting host, port, username of ssh server and setting tunneling needed.
and done.