From ba083e9b26e605eb32119869683a5f1570845a7d Mon Sep 17 00:00:00 2001 From: Janis Date: Fri, 24 Nov 2023 23:30:23 +0100 Subject: [PATCH] Fix bug in login functionality --- readme.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..b2da7a0 --- /dev/null +++ b/readme.md @@ -0,0 +1,17 @@ +# Minecraft Server Auto Starter for Docker Compose + +This container will manage the access to your Minecraft server. It will start the Minecraft server when a player tries to connect. +This container is designed to work with the [itzg/minecraft-server](https://hub.docker.com/r/itzg/minecraft-server) container. +It uses the AutoStop feature of the [itzg/minecraft-server](https://hub.docker.com/r/itzg/minecraft-server) container to stop the Minecraft server when no player is connected. + +## Usage + +See the [docker-compose.yml](https://github.com/DerTyp7/docker_minecraft_server_auto_starter/blob/main/docker-compose.yml) file for an example. + +## Environment Variables + +| Variable | Description | Default | Example | +| -------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------- | -------------- | +| `PLACEHOLDER_SERVER_SLEEPING_IP` | The internal docker-compose IP for the placeholder server when a server is sleeping | `""` | `"172.20.0.3"` | +| `PLACEHOLDER_SERVER_STARTING_IP` | The internal docker-compose IP for the placeholder server when a server is starting | `""` | `"172.20.0.4"` | +| `PORT_IP_MAP` | Map which matches the external Minecraft ports to the internal docker-compose IPs for the Minecraft-Servers | `` | |