Install

SYW Crafty runs in Docker on Linux. If you have Docker with the compose plugin, it takes a few minutes.

Not publicly released yet. SYW Crafty is in use by its makers, but its image is not yet available to download. This page shows how installing will work.

  1. Make a folder and a compose file

    Create a folder for it - for example ~/syw-crafty - and in it a file named docker-compose.yml:

    services:
  crafty:
    container_name: syw_crafty
    image: ghcr.io/syw-apps/syw-crafty:latest
    restart: unless-stopped
    environment:
      - TZ=Etc/UTC
    ports:
      - "8443:8443"                    # the panel (HTTPS)
      - "8000:8000"                    # HTTP
      - "25500-25600:25500-25600"      # Minecraft servers
      - "19132:19132/udp"              # Bedrock
      - "5520-5550:5520-5550/udp"      # Hytale
      - "8123:8123"                    # Dynmap
    volumes:
      - ./docker/backups:/crafty/backups
      - ./docker/logs:/crafty/logs
      - ./docker/servers:/crafty/servers
      - ./docker/config:/crafty/app/config
      - ./docker/import:/crafty/import

    Only open the ports you use. The Minecraft range is where new servers get their ports; Bedrock, Hytale and Dynmap can go if you do not run them.

  2. Start it

    docker compose up -d

    The first start creates its configuration in ./docker/config.

  3. Sign in

    Open https://<your machine>:8443. The panel uses a self-signed certificate at first, so your browser will warn once. The first username and password are in ./docker/config/default-creds.txt - change the password after you sign in.

Updating

docker compose pull
docker compose up -d

Changes to the database are applied when the panel starts.

Coming from Crafty Controller 4

You do not start over. SYW Crafty is Crafty Controller 4.11 with its own changes applied on top when it starts, so pointing it at an existing instance's folders upgrades that instance in place - accounts, passwords, roles, servers and their ports all carry over. This was tested from Crafty Controller 4.10.8.

  1. Stop the old instance: docker compose down.
  2. Copy its whole data folder - config, servers and backups together - somewhere safe.
  3. Change the image in your compose file to SYW Crafty's and run docker compose up -d, then watch docker compose logs -f while it upgrades.
The upgrade is one way. Going back means restoring that copy and running the old image against it, so do not skip step 2 - and from a release older than 4.10.8, expect more of Crafty Controller's own upgrade steps to run first.

Questions

Does it run on Windows?

Docker on Linux is the tested way. Native Windows is not tested in SYW Crafty.

Does my panel need to be reachable from the internet?

No. Players need to reach your Minecraft servers, but the panel itself can stay on your network. The Discord and Twitch integrations connect out, never in.

Where is the reverse proxy / HTTPS setup?

Put the panel behind your usual reverse proxy (NGINX, Caddy, Traefik) pointing at port 8443, with WebSockets allowed - the console and live status use them.