Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.larm.dev/llms.txt

Use this file to discover all available pages before exploring further.

Status pages let your users see what’s going on. Each page shows the current state of your components, active disruptions with their update timeline, and 90 days of uptime history. Pages are static HTML hosted on a global CDN. Every time a disruption is updated or a component changes state, the page is regenerated and pushed to edge nodes worldwide. It stays up even if Larm itself has issues.

How status pages work

Your status page is a view of your disruptions. When you create a disruption and post an update that affects a status page component, the page re-renders with the new state. When you resolve the disruption, the component goes back to operational and the disruption moves to the history section. With monitors: Monitors create disruptions automatically. If a status page component is linked to a monitor, the whole flow is hands-free — outage detected, disruption created, status page updated, subscribers notified, and resolved when the monitor recovers. Without monitors: Create disruptions yourself, post updates, choose which components are affected. You’re in control of the timing and the messaging. You can also hit the Post update button directly on a status page to create a disruption in one step — it’s a shortcut into the same disruption workflow.

Creating a status page

Go to Status pages and click New status page. Configure the settings, add components, and optionally customize the branding. Your page is published at https://<slug>.status.larm.dev.

Page settings

FieldDescription
NameDisplay name of the status page
SlugURL identifier (e.g. my-service becomes my-service.status.larm.dev). Lowercase, hyphens allowed, 3–63 characters.
DescriptionOptional brief description shown on the page (up to 1000 characters)
ThemeSystem (follows visitor’s preference), Light, or Dark
Primary colorBrand color in hex format (e.g. #4F46E5)
Logo (light)Logo shown in light mode (PNG, JPG, or SVG, up to 1 MB)
Logo (dark)Logo shown in dark mode (PNG, JPG, or SVG, up to 1 MB)
EnabledWhether the page is publicly visible (defaults to disabled)

Components

Components are the services or systems shown on your status page — “API”, “Dashboard”, “Payment processing”, whatever makes sense for your users. Each component has a name, optional description, and a display position. A component can be linked to monitors for automatic updates, or left standalone.

Component states

StateMeaning
OperationalEverything is working normally
Degraded performanceSlower than expected but still functional
Partial outageSome functionality is unavailable
Major outageService is down
Under maintenancePlanned maintenance in progress
Component state is set by disruptions. When a disruption update marks a component as “major outage”, that’s what your users see on the status page until the disruption is resolved or a newer update changes it.

Custom domains

Custom domains are available on paid plans.
Serve your status page from your own domain (e.g. status.example.com). Apex domains are not supported — use a subdomain.
  1. Enter your domain in the status page settings
  2. Add a CNAME record pointing your domain to <slug>.status.larm.dev
  3. If you’re using Cloudflare, also add a TXT record: _larm-verify.<your-domain> with value larm-verify=<token> (shown in the dashboard)
  4. Click Verify — Larm checks DNS and provisions SSL automatically

Email subscribers

Visitors can subscribe to your status page by email. When a disruption is updated, subscribers are notified automatically.
PlanSubscriber limit
Free100
Pro1,000
Business10,000