Quick install

On a Linux machine with Docker Engine and the Docker Compose plugin, run as root:

curl -fsSL https://shardkeep.gg/install.sh | sh

Read the script before you run it if you prefer: it is short. Or do the same by hand.

What it does

1. Checks that Docker and the Compose plugin are installed and that it can use them. It never installs Docker itself: see Docker’s install guide.
2. Downloads compose.yml from the latest Shardkeep release and checks it against the release’s checksums.txt.
3. Asks for the name or IP address people will use to reach this machine, such as shardkeep.example.com. It goes on the Controller’s certificate and in links.
4. Writes /opt/shardkeep/.env (readable only by root) with the release, that name, and a generated database password.
5. Starts the Controller, PostgreSQL and a bundled Agent with Docker Compose. The Agent enrolls itself, so this machine is your first Node.
6. Prints the address to open and how to get the setup code.

Options

Set these as environment variables, for example curl -fsSL https://shardkeep.gg/install.sh | SHARDKEEP_VERSION=1.20.0 sh:

Variable	Default	Meaning
SHARDKEEP_DIR	/opt/shardkeep	Where compose.yml and .env go
SHARDKEEP_VERSION	the latest release	Which release to install
SHARDKEEP_PUBLIC_NAME	asked; the host name without a terminal	The name or IP address people use to reach this machine

Next

Finish setup in your browser.