Site Alert Banner

1. What does this feature do? (High-Level Overview)

The Site Alert Banner lets authorized administrators publish a visible message on the login page for all users. It is used to communicate urgent operational updates such as login disruptions, outages, or high-impact incidents.

2. Who is this for? (Roles & Permissions)

• Superadmin: Can access and update the Site Alert Banner configuration in Admin View.
• Admin: Can access and update the Site Alert Banner configuration in Admin View.
• Custom administrative roles with use_admin_tools: Can access and update this feature when the permission is granted.

Required Permission: use_admin_tools

3. Business Rules & Enforcements

• Rule 1: The administration endpoints for this feature are protected by the permissionuse_admin_tools.
• Rule 2: Banner visibility on login depends on both conditions being true: is_enabled = true and message is not empty after trimming.
• Rule 3: Allowed alert levels are strictly limited to info, warning, and danger.
• Rule 4: Message length is limited to 2000 characters.

4. UI Placement

1. Admin View > Settings > Site Alert Banner (/settings/site-alert-banner) — Configuration screen to enable/disable the banner, select alert level, and edit message text.
2. Login page (/login) — Banner appears above the login form when enabled and message content is present.

5. How-To Guide (Step-by-Step)

Scenario A: Publish a login issue notice

1. Log in with an account that has use_admin_tools.
2. Open Settings in Admin View.
3. Click Site Alert Banner.
4. Turn on Show on login.
5. Select the alert level (Warning or Danger for service-impact events).
6. Enter the message users should see on the login screen.
7. Click Save changes.
8. Confirm the success message and validate the banner on the login page.

Scenario B: Turn off the banner after incident resolution

1. Return to Settings > Site Alert Banner.
2. Disable Show on login.
3. Click Save changes.
4. Verify the login page no longer shows the banner.

6. What happens if…? (Edge Cases / FAQ)

• Q: What happens if the banner is enabled but the message is blank?

  • A: The banner is not shown on the login page. The app requires both enabled status and non-empty message content.

• Q: Are HTML messages allowed?

  • A: Basic HTML is supported for formatting, but teams should validate their exact allowed markup in their environment before relying on advanced formatting.