MCServerDocker/README.md
2024-04-20 16:53:15 +02:00

31 lines
1.4 KiB
Markdown

# MCServerDocker
Runs a Minecraft Server inside a Docker container.
# Java Edition only
This only supports the true version of Minecraft, not that phone and console spinoff named "Bedrock Edition".
# Setting up
## Step 1: Installing
This will bootstrap MCSD.
```bash
git clone "https://git.staropensource.de/JeremyStarTM/mcserverdocker.git"
cd mcserverdocker
mkdir server
cp config.example.env config.env
```
## Step 2: Installing the server software
Rename the jar file of your preferred server software to `server.jar` and move it into the `server/` directory.
## Step 3: Modify the configuration
Take a look at the environment variables inside the `config.env` file.
## Step 4: Launching the server
You need to start your server two times as we need to generate the `server.properties` file first. MCSD will do this automatically for you.
```plain
# Use this to launch your server every time you need it
docker compose up -d
```
# Using RCON
To access your server console you must use RCON. To use it, set `enable-rcon` to `true` and `rcon.password` to `mcsdrcon` in your `server.properties` file. \
After doing that one-time setup, you simply need to execute `./rcon.sh` and you'll connect to your server's console.
## Security
You might be worried that the RCON port 25575 is accessible to the public. One quick look into the `docker-compose.yml` file however will tell you that it's not possible to access the RCON port unless the attacker has direct access to the machine.