Skip to content

Minecart - Dockerised Minecraft Server ​

GitHub commit activity GitHub Closed Pull Requests GitHub Issues

IMPORTANT

Minecart is currently in early development and is subject to breaking changes. Some features (such as automatic plugin installation) are currently limited to Paper and will be expanded to additional server types in the future.

Quick Start ​

Minecart is configured by a single minecart.yml file, this describes the current server, resources and configuration.

To create a simple PaperMC server, create a file named minecart.yml with the following contents;

yaml
server:
  type: paper
  version: latest
  eula: true

Then, create a docker-compose.yml file in the same directory with the following;

yaml
services:
  minecart:
    image: ghcr.io/harrisonablack/minecart
    tty: true
    stdin_open: true
    ports:
      - "25565:25565"
    volumes:
      - ./minecart.yml:/app/minecart.yml:ro
      - ./data:/data
    restart: unless-stopped

The server can then be started using;

bash
docker compose up -d

NOTE

The container runs as an unprivileged user (UID 10001). On Linux hosts, ensure ./data exists and is writable by UID 10001 before starting (e.g. mkdir -p data && sudo chown 10001:10001 data), or use a named Docker volume instead.

To then attach to the console, use;

bash
docker compose attach minecart

The server will now be available locally at localhost:25565.

For a more verbose initial setup, please see getting started, for further configuration, please see configuration