This document contains the instructions for hosting a KME3 server
KME has a dockerfile in the root of the project this can be used to host the server within docker which requires no extra setup. The docker server can be configured using Environment Variables if you are using docker then you can skip all other portions of this guide
- Java 17 (If you would like to use another Java version you must recompile KME against that version)
- The server executable (This can be found in the releases)
Prepare a folder for you server. Depending on your configuration the server will generate both
a logs and a data folder along with a config.yml ensure that you have a location prepared for this
and make sure you set it to your working directory (Command is most likely cd but use your systems command)
To start the server run the following command
java -jar server.jar
If you have renamed the file you must replace server.jar with the new file name to make starting up the server easier you can use a shell / bash script to run this command for you.
That it your server is all up and running you can adjust the configuration file (config.yml) to change the server settings.
NOTE: You must restart the server to apply configuration changes
If you are looking for information on how to connect to the server now you can take a look at
KME3 can be configured using environment variables. You can view a list of them at Environment Variables
If you haven't already make sure that you are forwarding the 4 ports you have inside your config by default these ports are 42127, 14219, 9988, and 80 however you can change all of these except redirector port. Search online for guides on port forwarding for your specific router