First-run setup

Open https://<your public name>:8080. Until you configure your own certificate, the Controller uses a self-signed one, so your browser warns once.

A new Controller sends everyone to the setup page, which walks you through:

1. Your account. Enter the setup code, which proves you have access to the Controller’s machine. Print it with:

   cd /opt/shardkeep && docker compose exec controller shardkeep admin setup-code

   Then choose your username, email and password (at least 15 characters). This becomes the first global administrator.

2. Your network. Its name, an optional description shown in players’ server lists, and an optional logo (PNG or JPEG, at most 512 KiB).

3. Its address. The host name players will type, such as play.example.com, and its port (25565 unless you change it). See Your network’s address for the DNS record.

4. The proxy. Shardkeep creates the Velocity proxy on one of your Nodes, on the network’s port. You can skip this and do it later from the Network page.

When it says Your network is ready, the setup code is gone and setup cannot run again. Create your first server from there.

Without the web UI

shardkeep admin create-user creates a global administrator from the command line (see Admin commands). The network is then set up from the Network page.