Administration2 min read
Administration
Operate users, authentication, notification providers, custom fields, retention, and audit evidence.
Administration turns a working OpsKnight installation into a governed service. Use these guides to configure access, delivery providers, metadata, retention, and audit review.
Guides
| Guide | Use it to |
|---|---|
| Notifications | Configure email, Twilio SMS, web push, WhatsApp, Slack/service delivery boundaries, user preferences, and history. |
| Authentication | Configure local credentials and OIDC sign-in safely. |
| Custom fields | Add structured incident metadata and control public exposure. |
| System settings | Safely change application URL, OIDC, retention, encryption, and performance settings. |
| Data retention | Set cleanup policy and understand reporting/status-history effects. |
| Audit logs | Investigate user, team, service, policy, and administrative changes recorded by v1.4. |
| System logs | Troubleshoot the current process and understand the boundary with durable platform logs. |
| Administrator Health Center | Review database, migration, worker, paging, provider, backup, URL, encryption, and version signals. |
User, team, service, schedule, escalation-policy, and API-key operations are also documented in their task guides. The API index intentionally does not publish Users, Teams, Services, or Schedules REST contracts.
Recommended setup order
- Create a second Admin and define break-glass access.
- Choose local credentials, OIDC, or a controlled combination.
- Configure one outbound provider and test a real delivery path.
- Invite Responders and verify personal preferences/contact data.
- Build teams, schedules, policies, and services.
- Define custom fields and status-page privacy before storing sensitive metadata.
- Choose retention only after backup, compliance, analytics, and public-history review.
- Establish a recurring audit, provider-failure, access, backup, and credential-rotation review.
Notification baseline
| Need | Supported v1.4 choice |
|---|---|
| Resend, SendGrid, SMTP, or Amazon SES. | |
| SMS | Twilio. |
| Mobile push | Standard Web Push/PWA with VAPID. |
| Twilio WhatsApp Business. | |
| Slack | Slack workspace/OAuth and service configuration. |
| External HTTP | Service or status-page webhooks, depending on audience. |
Twilio and AWS SNS are the v1.4 SMS choices. FCM and OneSignal are not the v1.4 push-provider model. There is no native voice/PSTN channel.
Administrator safety rules
- Keep at least two active Admins and do not share accounts.
- Store all credentials in approved secret storage.
- Test authentication, notifications, schedules, and escalation after every relevant change.
- Deactivate before deleting users unless permanent removal is required.
- Back up and verify restore before retention changes, upgrades, or destructive operations.
- Treat status-page, webhook, notification, audit, and analytics data as potentially sensitive.
- Use the published UI and API contracts; the existence of an internal route is not authorization to integrate against it.
Related topics
Last updated for v1.4
Edit this page on GitHub