llms.txt
Search Documentation
Search through all documentation pages
Setup Guide

Site Configuration

Configure core site settings and understand where they affect runtime behavior

Use Manage → Site Configurations to control identity, navigation, monitor sharing controls, page visibility behavior, retention, and event visibility.

Quick setup

  1. Open Manage → Site Configurations.
  2. Save Site Information (siteName, siteURL, logo, favicon).
  3. Configure Navigation Menu.
  4. Set Monitor Sub Menu Options.
  5. Configure Global Page Visibility Settings.
  6. Configure Social Preview & SEO.
  7. Configure Data Retention Policy.
  8. Configure Event Display Settings.

Runtime impact map

Setting area Stored key Runtime impact
Site name / URL / logo / nav siteName, siteURL, logo, nav Rendered in top navbar branding and nav links
Favicon favicon Used in <head> as page icon
Monitor sub menu options subMenuOptions Gates monitor share actions (badges/embed) on public monitor pages
Global page visibility globalPageVisibilitySettings Controls page switcher visibility and page-scoped navigation/events
Data retention policy dataRetentionPolicy Controls daily cleanup of old monitoring_data
Social preview & SEO metaSiteTitle, metaSiteDescription, socialPreviewImage Default <title>, og:title, <meta description>, og:description, og:image for all pages

Monitor sub menu options

These site-level flags control share actions globally:

  • showShareBadgeMonitor
  • showShareEmbedMonitor

Important

These site-level toggles are combined with monitor-level sharing options. If site-level is disabled, monitor-level cannot force it on.

See Sharing Monitors.

Global page visibility settings

globalPageVisibilitySettings has two flags:

  • showSwitcher: boolean

    • Controls whether the page switcher dropdown is visible in the top controls.
    • true: users can switch pages from the selector.
    • false: page selector is hidden.
  • forceExclusivity: boolean

    • Enables page-scoped behavior for navigation/events.
    • In the dashboard UI, enabling this automatically sets showSwitcher to true and locks it as read-only.
    • Runtime effects:
      • navbar brand/logo click resolves to the current page path (/{page_path}) instead of global root,
      • notifications calendar link resolves to page-scoped events (/{page_path}/events/{MMMM-yyyy}),
      • events-by-month API is filtered to monitors assigned to that page (global incidents/maintenances still appear).

Important

forceExclusivity takes precedence over showSwitcher behavior for page-scoped navigation/event flows.

See Pages.

Data retention policy

dataRetentionPolicy drives the daily cleanup scheduler:

  • enabled: turn cleanup on/off
  • retentionDays: how many days of monitor data to keep

When enabled, cleanup runs daily at midnight UTC.

Event display settings

eventDisplaySettings controls which events are visible:

  • incidents: ongoing/resolved + resolved limits
  • maintenances: ongoing/past/upcoming + limits

This affects:

  • event sections on status pages
  • notifications payload API used by the UI

Social preview and SEO

The Social Preview & SEO card sets site-wide defaults for meta tags used in search engines and link previews.

Field Stored key Meta tags affected
Meta Title metaSiteTitle <title>, og:title
Meta Description metaSiteDescription <meta name="description">, og:description
Social Preview Image socialPreviewImage og:image, twitter:image

These values are used as defaults for every page. Individual pages can override them — see Pages → Social Preview & SEO.

Tip

Upload a 1200×630 image for best results across social platforms.

Verify changes

  • Update site name/logo/nav and refresh home page.
  • Toggle monitor share options and verify Badge/Embed actions on a monitor page.
  • Toggle showSwitcher and verify the page selector appears/disappears.
  • Enable forceExclusivity and verify:
    • brand link stays within current page path,
    • notifications calendar opens page-scoped events for the current month.
  • Change event display settings and verify incident/maintenance visibility.
  • Set retention policy and confirm scheduler logs in server output.
  • Set meta title/description and social preview image, then check <meta> tags in page source.