MiniMC

Your lightweight Minecraft server companion!

What is MiniMC?

MiniMC is a simple, self-contained Minecraft server manager with a built-in web interface.

• Start your server by typing start in the terminal.
• Stop it with stop.
• If it crashes, use kill.
• Includes a web-based file manager, accessible via /files in the terminal.

Features

• Automatically downloads and runs the latest PaperMC server build.
• Single-container setup designed with Docker in mind.
• Lightweight, but includes advanced logging in the web interface.
• Self-contained: all server files are stored locally in /minecraft.

Getting Started

1. Clone the repository:

git clone https://github.com/bijsven/MiniMC.git
cd MiniMC

2. Configure Docker Compose to your needs. By default:

• Minecraft server exposed on 25565
• Web interface exposed on 8080
• Server files stored in /minecraft locally and internally within the container

3. Start MiniMC:

docker-compose up

4. Access the web interface via http://localhost:8080 and manage your server easily.

Recommended: Make your web server available

5. Enter your host terminal and type:

docker compose exec -it minimc ssh -T -R 80:localhost:8080 nokey@localhost.run

7. Use the url to access your MiniMC web instant.
8. Then, to make your minecraft server easily accessable I recommand you use playit.gg's plugin
9. Follow the instructions from the logs
10. Your done! Enjoy your instant!

Usage Notes

• MiniMC auto-updates the PaperMC server jar whenever restarted.
• Use the terminal commands (start, stop, kill) to control the server.
• All server data is persistent inside the /minecraft folder, so you can safely restart or update the container.

License

MIT License – see LICENSE