mirror of
https://github.com/andrei-cerbulescu/mc-overseer.git
synced 2025-12-16 15:14:12 -06:00
main
Getting Started
This project is an orchestrator for your Minecraft servers that can be run in Docker.
It is aimed to help reduce a server's power draw when nobody is connected, suspending the instance.\
Prerequisites
Other than Docker, there is nothing else that you require.
You can check the docker-compose.yaml and config.json files from this repository as an example to get yourself started.
Running
This guide will use the default network name I specified in both docker-compose.yaml and config.json files.
- Run
docker network create mcdockerseer - Update
config.jsonfor your first server with the absolute path to it. - Update
privatePortandpublicPortto your liking (private: the actual server's port; public: the port you will be connecting to) - Set
max-tick-time=-1inside all servers'server.propertiesfiles. - Run
docker compose up -d
Contributing
As this is an open source project, feel free to create a pull request with your own code or an issue requesting a new functionality.
Description
Languages
Java
99.3%
Dockerfile
0.7%