A simple web interface to create and manage Minecraft servers. Run as many servers as you want, install mods with one click, and manage everything from your browser.

What you need:

• Docker Desktop (Windows/Mac) or Docker + Docker Compose (Linux)
• That's it!

Linux/macOS:

curl -fsSL https://mineos.net/install.sh | bash

Windows (PowerShell):

iwr https://mineos.net/install.ps1 -useb | iex

The installer will:

• Check Docker + Docker Compose
• Create all necessary files and folders
• Configure environment settings
• Start MineOS automatically

Access MineOS: Open http://localhost:3000 in your browser

If you prefer to install manually or need offline installation:

1. Download the install bundle from the latest GitHub release:

   • mineos-install-bundle.tar.gz (Linux/macOS)
   • mineos-install-bundle.zip (Windows)

2. Extract the bundle:

   # Linux/macOS
   tar -xzf mineos-install-bundle.tar.gz
   cd mineos
   
   # Windows (PowerShell)
   Expand-Archive mineos-install-bundle.zip -DestinationPath mineos
   cd mineos

3. Configure environment:

   cp .env.template .env
   # Edit .env with your preferred settings

4. Start MineOS:

   docker compose up -d

5. Access MineOS: Open http://localhost:3000

Use the mineos CLI tool to manage your installation:

mineos status      # Check service status
mineos stop        # Stop all services
mineos start       # Start all services
mineos restart     # Restart all services
mineos logs        # View logs
mineos update      # Update to latest version

The CLI is automatically installed during setup.

MineOS will start automatically whenever Docker starts. Create servers, install mods, and manage everything from the web interface.

mineos uninstall

The uninstall will ask if you want to keep your server data before removing anything.

• Server data: ./minecraft/ folder (all your Minecraft servers)
• Database: ./data/mineos.db (MineOS settings)

Need to change ports? Edit .env and run docker compose restart

Want Minecraft LAN discovery? Re-run the installer and enable host networking when prompted. This is Linux-only and disables Docker network isolation (containers bind directly to API_PORT/WEB_PORT on the host). The installer automatically configures docker-compose.host.yml when needed.

Docker not found? Make sure Docker Desktop (Windows/Mac) or Docker + Docker Compose (Linux) is installed and running before installing MineOS.