Administration
Panel settings
Panel-wide settings live under Settings. Everyone with settings:read (SuperAdmins and
Admins) can see them; only SuperAdmins can change them (settings:write). Every change is
recorded in the audit log.
Branding
| Setting | Default | Meaning |
|---|---|---|
| Product name | NGCP |
Shown in the title bar and on the sign-in page, and used as the sender name in notifications (read at controller start). Up to 40 characters. |
| Support link | empty | An optional http(s):// link shown on the sign-in page. |
Security
| Setting | Default | Range | Meaning |
|---|---|---|---|
| Shortest password allowed | 12 | 8-128 | Minimum password length for new and changed passwords. |
| Require two-step verification for admins | off | SuperAdmins and Admins without two-step verification must turn it on before doing anything else. Turn it on for your own account first; the panel refuses otherwise. | |
| Sign out after idle (hours) | 12 | 1-720 | A session ends after this long without use. |
| Longest session (days) | 7 | 1-90 | A session ends this long after sign-in, even when in use. Must not be shorter than the idle time. |
| Admin IP allow-list | empty (any) | up to 100 entries | IP addresses or CIDR ranges SuperAdmins and Admins may sign in from. Applies to sessions, API keys and SFTP too. The panel refuses a list that excludes your own current address. |
| Allow SFTP passwords for accounts with two-step verification | off | Off: accounts with two-step verification use SSH keys for SFTP. On: their password alone works for SFTP, which skips the second step. |
The settings page shows your own address as the panel sees it; check it before saving an allow-list, especially behind a reverse proxy.
Steam accounts
Settings -> Manage Steam accounts holds the Steam logins SteamCMD uses (needs
nodes:write). See Steam and the Workshop.
Notifications: SMTP and templates
The outgoing mail server for e-mail notifications and the message templates for every event are
SuperAdmin settings. Webhooks themselves are managed by anyone with webhooks:write. See
Notifications. Both are tabs of the Notifications page (E-mail server
and Message texts); the API equivalents:
| What | API |
|---|---|
| SMTP server | GET / PUT /api/v1/settings/smtp |
| Message templates | GET / PUT /api/v1/settings/notification-templates |
Settings that are not in the panel
Some things are configured outside the web interface:
| What | Where |
|---|---|
| Listen addresses, public URL, agent address, TLS certificates, trusted proxies, log level | controller.env, see Installing the controller |
| Node port range, mode, firewall management, services and SteamCMD directories | Each node’s settings under Nodes |
| SFTP port, direct file endpoint, log level of a node | agent.yaml on the node, see Adding a node |
| Backup targets, global schedules | The Backups and Schedules pages (left menu) or the API |
Through the API
curl -s https://panel.example.com/api/v1/settings -H "Authorization: Bearer ngcpk_..."
PUT /api/v1/settings replaces the whole settings document (branding and security); send back
everything you read with your changes applied.