Browse documentation

Pharos / Docs / v1.0.1

First run

Updated 2026-10-22 · Pharos 1.0.1

Sign in at /admin/login. You land on the Overview of your status page: what the public page says right now, the key figures, 90 days of availability, services and the open incident.

The Overview of the Northwind Hosting page: a partial outage banner with 11 of 12 components operational, tiles for 90 day uptime, open incidents, the last 30 days and subscribers, the availability bar, services and the open incident with its timeline
Overview. The first screen after sign in, per status page. The sidebar groups This page (with the page selector) and Installation.

Press Ctrl K or Cmd K, or click Search in the sidebar, to jump to any page, service, component, incident, maintenance window or admin screen. Results are grouped, show their page and status, and only cover the pages you hold a role on.

The search palette over the admin with the query web: six components, one incident and a maintenance window, each with its page tag and status
Search. Arrow keys to move, Enter to open, Esc to close. The current page comes first.

Create services first, the headings your customers read, then put components inside them.

A component with no service is still published. It appears on the public page as a row of its own, without a heading, and it counts toward the headline uptime figure. Put components in a service when you want them grouped under a name your customers know.

Choosing a source

The Source field says who sets the status, and with that whether a check exists at all:

SourceWho sets the statusUptime
HTTP or TCP checkPharos, with an HTTP, TCP or DNS check on your target and interval.Measured by the check
Heartbeat from your jobPharos, from a URL your job calls. The token is generated once and shown on the component.Measured by the check
Uptime Kuma, API or webhook, Upstream providerSomething outside Pharos writes it through the API. There is no check.Counted from the reported status
Manual onlyYou, in the admin.Not measured

You rarely have to pick the outside sources by hand. The first time the API or the Uptime Kuma endpoint writes a status for a component that has no enabled check, Pharos marks it as set from outside by itself. A status you set by hand in the admin changes nothing, and a component with its own check is left alone. See Uptime for how reported time is counted.

Hidden service versus disabled component

 Service hiddenComponent disabled
Shown to customersNoNo
Checks keep runningYesNo
Counts toward the headline on the public pageNoNo
History keptYesYes

Hide a service to stop showing customers something you are still watching. Disable a component to stop watching it entirely while keeping its past.