1. Documentation
  2. Manage Status Page
  3. Identity
ReadmeGitHub
  • Introduction
  • Quickstart
  • CLI
  • Configuration
  • Identity
  • Branding
  • Themes
  • Monitors
  • Checks and scheduling
  • Metrics and badges
  • Incidents
  • Maintenance
  • Notifications
  • Subscribers
  • React Router
  • Next.js
  • Astro
  • SQLite
  • Cloudflare D1
  • PostgreSQL
  • Schema and migrations
  • Cloudflare
  • Vercel
  • Self-hosting
  • API overview
  • Status endpoints
  • Incident endpoints
  • Maintenance endpoints
  • Subscriber endpoints
  • Badges, feeds and metrics
  • Admin endpoints
  • The check run
  • Uptime and history
  • Automatic incidents
  • Notification delivery
  • Public subscriptions

Identity

Set the status page title, description, canonical URL and API base path.

Your page has two names: title appears in metadata, feeds and notifications; branding.name appears in the header. Set the page title and public URL in heyo-status.config.ts, then configure the header brand separately.

Title and description

heyo-status.config.ts
import { heyoStatus } from "@heyo-sh/heyo-status/config";import { sqlite } from "@heyo-sh/heyo-status/db";export const statusPage = heyoStatus({  database: sqlite("status.sqlite"),  title: "Acme Status",  description: "Real-time status for Acme services.",  monitors: [],});

If you omit title, the page uses "Heyo Status". It appears in page metadata, feed titles, notification subjects and subscription email, not in the header. description defaults to "Real-time service status and uptime." and appears in metadata and feed descriptions. Write it as you would a short search-result excerpt.

Canonical URL

heyo-status.config.ts
siteUrl: "https://status.acme.com",

Set siteUrl to the address visitors will actually use. Feeds, notifications and subscription emails need it for absolute links. Without it, links fall back to the request origin, which can be wrong behind a proxy. Use an HTTP(S) URL without a query or fragment; a trailing slash is removed.

API base path

heyo-status.config.ts
basePath: "/api/heyo-status",

The default is /api/heyo-status. All public and admin endpoints are mounted under it. If you change it, change the framework catch-all route at the same time (for example, app/status-api/[...path]/route.ts for Next.js with basePath: "/status-api"). The path must start with /, must not equal /, and cannot contain //, a query or a fragment.

Metadata lives in your framework shell

The generated layouts and routes use the config for page metadata. If you integrate Heyo Status manually, set your framework's title, description and document language in its root layout too.

Next steps

  • Choose a theme
  • Add your brand
Configuration< PreviousBrandingNext >

Powered by heyo

On this page

Title and descriptionCanonical URLAPI base path