https://github.com/dertyp7/docker_minecraft_server_auto_starter
https://github.com/dertyp7/docker_minecraft_server_auto_starter
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/dertyp7/docker_minecraft_server_auto_starter
- Owner: DerTyp7
- Created: 2023-11-24T12:57:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-28T20:00:16.000Z (over 1 year ago)
- Last Synced: 2023-12-28T21:48:21.325Z (over 1 year ago)
- Language: Python
- Size: 58.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# 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` | (optional) The internal docker-compose IP for the placeholder server when a server is sleeping | `""` | `"172.20.0.3"` |
| `PLACEHOLDER_SERVER_STARTING_IP` | (optional) 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 | | |