|
| 1 | +# System Settings Management |
| 2 | + |
| 3 | +The `pangolin-admin` tool provides commands to view and update global system configuration. These settings are stored in the backend database and override default environment variables where applicable. |
| 4 | + |
| 5 | +## Commands |
| 6 | + |
| 7 | +### `get-system-settings` |
| 8 | + |
| 9 | +Retrieve the current global system configuration. |
| 10 | + |
| 11 | +**Usage:** |
| 12 | +```bash |
| 13 | +pangolin-admin get-system-settings |
| 14 | +``` |
| 15 | + |
| 16 | +**Output:** |
| 17 | +```json |
| 18 | +{ |
| 19 | + "allow_public_signup": false, |
| 20 | + "default_warehouse_bucket": "warehouse", |
| 21 | + "default_retention_days": 30, |
| 22 | + "smtp_host": "smtp.example.com", |
| 23 | + "smtp_user": "admin" |
| 24 | +} |
| 25 | +``` |
| 26 | + |
| 27 | +### `update-system-settings` |
| 28 | + |
| 29 | +Update one or more global configuration parameters. |
| 30 | + |
| 31 | +**Usage:** |
| 32 | +```bash |
| 33 | +pangolin-admin update-system-settings \ |
| 34 | + --allow-public-signup true \ |
| 35 | + --default-retention-days 90 |
| 36 | +``` |
| 37 | + |
| 38 | +**Options:** |
| 39 | +- `--allow-public-signup <bool>`: Enable or disable public user registration. |
| 40 | +- `--default-warehouse-bucket <string>`: Default bucket name for new warehouses. |
| 41 | +- `--default-retention-days <int>`: Default data retention period. |
| 42 | +- `--smtp-host <string>`: SMTP server hostname. |
| 43 | +- `--smtp-port <int>`: SMTP server port. |
| 44 | +- `--smtp-user <string>`: SMTP username. |
| 45 | +- `--smtp-password <string>`: SMTP password (write-only). |
| 46 | + |
| 47 | +**Example:** |
| 48 | +```bash |
| 49 | +# Enable public signup and set default retention to 60 days |
| 50 | +pangolin-admin update-system-settings --allow-public-signup true --default-retention-days 60 |
| 51 | +``` |
0 commit comments