Docker Compose Setup

The orchestrator is built primarily to work gracefully within Docker environments, particularly docker-compose.

Minimal Setup

A docker-compose.yml deploying a basic Paper server looks like this:

services:
  minecraft:
    image: ghcr.io/mauricenino/minecraft-server:latest
    environment:
      TYPE: PAPER
      VERSION: latest
      MEMORY: 2G
      ACCEPT_EULA: true
      PLUGINS: |
        modrinth:luckperms@latest
        hangar:viaversion@latest
    volumes:
      - ./data:/data/runtime
    ports:
      - '25565:25565'

Volumes & State

Inside the container, /data is the target directory via DEFAULT_DATA_DIR.

/data/runtime: Where the server execution happens (and where you should mount to persist data).
/data/templates: Where you should mount your config skeletons.

Example Environments

Interested in load-balanced setups or proxies? We have curated examples, such as a complete Velocity network connecting multiple survival and creative instances seamlessly.

Check the examples/ directory in our repository:

👉 View Examples