Command-line tools
| Tool | Runs | Documented in |
|---|---|---|
install.sh | Installs or updates a server install | Install on a server |
manage.sh | Controls, updates and checks the services | Services |
publisher.sh | The admin CLI, as the service user | Below |
sync-env.sh | Adds to .env the settings template.env has and it lacks | Upgrading |
scripts/setup-postgres.sh, scripts/setup-mysql.sh | Sets up a database server | Database |
scripts/setup-rabbitmq.sh | Sets up a RabbitMQ broker | Celery broker |
scripts/setup-observability.sh | Sets up SigNoz and Uptime Kuma | Observability |
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.
| Group | Commands | Documented in |
|---|---|---|
creds | create, list, scopes, set-scopes, reset-password, disable, enable, revoke-sessions, delete | Credentials and access |
platforms | add, update, list, disable, enable, remove, config show, config set, setup, import, exec | Managing adapters |
gateway-clients | suggest, create, list, update, disable, enable, delete, countries, operators, mcc-mnc list | Managing gateway clients |
config | check | Settings reference |
seed | stats, creds, platforms, gateway-clients | None; fills a development database with sample data |
It also takes env and shell (Services).