Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Command-line tools

ToolRunsDocumented in
install.shInstalls or updates a server installInstall on a server
manage.shControls, updates and checks the servicesServices
publisher.shThe admin CLI, as the service userBelow
sync-env.shAdds to .env the settings template.env has and it lacksUpgrading
scripts/setup-postgres.sh, scripts/setup-mysql.shSets up a database serverDatabase
scripts/setup-rabbitmq.shSets up a RabbitMQ brokerCelery broker
scripts/setup-observability.shSets up SigNoz and Uptime KumaObservability

Run them with sudo; all but install.sh from the install directory. Each takes --help.

manage.sh

See Services.

publisher.sh

Runs python3 -m publisher as the service user. sudo ./publisher.sh <GROUP> <COMMAND> --help describes each command.

GroupCommandsDocumented in
credscreate, list, scopes, set-scopes, reset-password, disable, enable, revoke-sessions, deleteCredentials and access
platformsadd, update, list, disable, enable, remove, config show, config set, setup, import, execManaging adapters
gateway-clientssuggest, create, list, update, disable, enable, delete, countries, operators, mcc-mnc listManaging gateway clients
configcheckSettings reference
seedstats, creds, platforms, gateway-clientsNone; fills a development database with sample data

It also takes env and shell (Services).