Skip to content

Command line ​

The backend image includes an interactive CLI for tasks that need server access, also when nobody can sign in to the panel:

bash
docker compose exec -it backend aerostat cli

Pick a command by its number or name:

CommandWhat it does
migrateRuns the database migrations
create-adminCreates an admin account, or sets a new password for an existing one
usersLists all accounts, with who is admin and who is suspended
reset-passwordSets a new password for an account, by username or email
unblockLifts a sign-in block for an account or IP address
reset-2faTurns off the authenticator app and email codes and removes the recovery codes
remove-passkeysRemoves every passkey of an account and turns password sign-in back on
enable-password-loginTurns password sign-in back on
set-emailChanges or removes an email address
backupsLists the backups
backupMakes a backup now
restorePuts a backup back, after backing up the database as it is now
set-ownerMakes an account the owner, every other owner becomes a normal admin
unsuspendLets a suspended account sign in again

Each change shows up under Activity in the panel.

create-admin ​

Accounts made with create-admin are admins and the owner of the install. Running it again for an existing account sets a new password and lifts a suspension, so it also works as a way back in.

It runs on its own too, without opening the CLI:

bash
docker compose exec -it backend aerostat create-admin --username admin

It asks for the password twice. In a script, pass it with ADMIN_PASSWORD instead:

bash
docker compose exec -e ADMIN_PASSWORD='a-long-password' backend aerostat create-admin --username admin

Released under the MIT License.