System info page for the administrator #28

Closed
opened 2026-10-15 01:05:03 -04:00 by vmanne-poc · 0 comments
Owner

Goal: let the administrator see how this server is set up without reading environment variables or logs.

Plan

  • GET /system/info, administrator only (RootGuard). It returns:
    • Postak version and Node version
    • database: reachable, applied migrations, pending migrations
    • whether self-registration is on
    • whether system mail is configured, which enables password reset (show the from address only)
    • whether SES bounce notifications are on (number of allowed topics)
    • whether the scheduler is on
    • PUBLIC_URL and POSTAK_APP_URL
  • Never return secrets: no SMTP credentials, JWT secret, or full connection strings. Tests check this.
  • System info page linked from the sidebar for the administrator. Settings that are off include a short hint on how to turn them on.

Done when

  • e2e tests cover root-only access and the no-secrets rule.
  • A component test covers the page.
**Goal:** let the administrator see how this server is set up without reading environment variables or logs. **Plan** - `GET /system/info`, administrator only (`RootGuard`). It returns: - Postak version and Node version - database: reachable, applied migrations, pending migrations - whether self-registration is on - whether system mail is configured, which enables password reset (show the from address only) - whether SES bounce notifications are on (number of allowed topics) - whether the scheduler is on - `PUBLIC_URL` and `POSTAK_APP_URL` - **Never return secrets:** no SMTP credentials, JWT secret, or full connection strings. Tests check this. - **System info** page linked from the sidebar for the administrator. Settings that are off include a short hint on how to turn them on. **Done when** - e2e tests cover root-only access and the no-secrets rule. - A component test covers the page.
Sign in to join this conversation.
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
vmanne-poc/Postak#28
No description provided.