ewan's docs

mc-server is a personal Minecraft server setup using Docker Compose with PaperMC, Spigot plugins, and an optional DuckDNS dynamic DNS companion script. Primarily intended for personal use or small groups.

Setup

Run the master setup script first — it checks prerequisites, configures the server, and optionally sets up a mcserver shell alias:

./scripts/setup_master.sh

Start, stop, and check status using the alias (if configured):

mcserver start
mcserver stop
mcserver status

Or directly:

./scripts/server_status_linux.sh start   # Linux
./scripts/server_status_mac.sh start     # macOS

Optional: DuckDNS

A companion script handles dynamic DNS updates via DuckDNS — see docs/duckdns.md for setup steps.

Documentation

Detailed docs live in the docs/ directory:

features.md — What's included
system-requirements.md — Hardware and software requirements
getting-started.md — Full setup walkthrough
usage.md — Day-to-day usage
maintenance.md — Backups and upkeep
troubleshooting.md — Common issues
rules.md — Server rules

Licence

See repository.