Skip to content
Shardkeep

Admin commands

Administration commands run with the Controller’s binary, on the Controller’s machine. In the Compose install:

Terminal window
cd /opt/shardkeep
docker compose exec controller shardkeep admin <command>

setup-code

Section titled “setup-code”
Terminal window
shardkeep admin setup-code [-data-dir DIR]

Prints the one-time code first-run setup asks for. Once the first administrator exists, there is no code and it says so.

create-user

Section titled “create-user”
Terminal window
shardkeep admin create-user -username NAME -email EMAIL [-display-name NAME] [-global-admin]

Creates a user and prints a one-time password, which they must change when they first sign in. With -global-admin, the user is a global administrator.

reset-password

Section titled “reset-password”
Terminal window
shardkeep admin reset-password USERNAME

Gives the user a new one-time password, ends their sessions and revokes their API tokens. Use it if you are locked out.

create-user and reset-password take -database-url (default $SHARDKEEP_DATABASE_URL, already set in the Compose install).

Shardkeep is free software under the AGPL-3.0. Minecraft is a trademark of Mojang AB; Shardkeep is not affiliated with or endorsed by Mojang or Microsoft.