Skip to main content
Version: 0.4 · current

Set up the public status page

How-to guideReviewed October 11, 2026
Applies to:Excubius 0.4Roles: Entity admin
PlansFree · Core · Pro · EnterpriseDeploymentSelf-hosted

Each entity can publish one status page for people without an account: the customers of a client, the staff of a branch, a partner. It answers one question, is the service I use working?, in the entity's own name, logo and colours. This guide shows how to create the page, build its components, post incidents and publish it.

Before you begin​

  • You need the Entity admin role on the entity the page represents.
  • The feature ui.public_status_page must be on. While it is off, the page cannot be opened and the screen says so; a super admin switches it in Settings › Instance.
  • Decide what visitors should recognise: services such as Customer portal or Card payments, not server names.

What visitors see, and what they never see​

The page is built field by field from an allow-list, never by filtering internal data.

On the pageNever on the page
The title, introduction, logo, theme and accent colourResource names, host names, types, tags or IDs
Components with the names you give them, in groups and in your orderChecks, metrics, values or thresholds
Each component's status and its 90-day availability barAlerts, their titles, severities or counts
The incidents you post, with every update and its timeWho posted, who is assigned, anything from the alert inbox
Maintenance you choose to announce, with its public title and descriptionThe internal reason of a maintenance window
Links to RSS, Atom and JSON Feed, and a discreet Sign in linkEntity paths, other entities, or the product's name and logo

Create the page​

  1. Open Settings › Status page and choose the entity in the picker, for example Ciguapa Inc..

  2. Select Create a status page for Ciguapa Inc.. The page is created unpublished.

  3. Under Page, fill in the settings:

    SettingNotes
    TitleAlso names the browser tab and the feeds
    IntroductionA short text under the title
    Logo addresshttps://… or a path on this server, such as /logos/ciguapa.svg. When empty, the branch's logo is used, if it has one; never the product's
    ThemeAny of the console themes; Daylight by default
    Accent colourA colour for links and focus rings, or Use the theme's
    Time zone of the daily barsWhere each day of the availability bars starts and ends. Times of incidents and maintenance are shown in each visitor's own time zone
    Own domainOptional, such as status.ciguapa.example; see below
  4. Select Save.

The Public address is https://<server>/status/<entity short name>. Open the public page opens it; Show preview shows it here, published or not.

Add components​

A component is something visitors recognise. It follows resources of the page's entity or of entities below it: a whole resource, or a single check of a resource when only that check matters to the service.

  1. Under Components, select Add a component.
  2. Enter the Name, for example Card payments, and optionally a Description and a Group. Components with the same group are shown together.
  3. Under Follows, choose a Resource and either The whole resource or one Check, then select Follow. Repeat for every resource the service depends on.
  4. Keep Show the 90-day availability bar selected unless a percentage means little for this component.
  5. Leave Status shown on From what it follows.
  6. Select Save component.

Use the arrows to change the order. The screen shows next to each component what the resources it follows say, so a stale manual status is easy to spot.

What it follows saysComponent status
Every followed resource is healthy; a check at info counts as healthyOperational
One is at warningDegraded performance
Some are critical or cannot be reachedPartial outage
All of those that report are criticalMajor outage
All of them are in a maintenance windowUnder maintenance
Nothing has reported yetOperational on the page, No data in the bars

Resources in maintenance count neither for nor against: one database node in maintenance and the other healthy is Operational. A silenced resource counts by the real state of its checks, because silencing changes notifications, not the service.

To override the status by hand, for example Major outage while you know more than the checks do, choose it in Status shown. Set it back to From what it follows afterwards.

Publish the page​

  1. Check the page with Show preview.
  2. Under Page, select Published, then Save.

While the page is unpublished, its address answers not found; the preview keeps working.

Report an incident​

  1. Under Incidents, select Report an incident.
  2. Enter the Title, the Impact (No impact, Minor impact, Major impact or Critical impact), the Affected components, the Status and a first Message.
  3. Select Report. The incident and its first update appear on the page and in the feeds with their time.
  4. As you learn more, post updates with Post update, each with a status (Investigating, Identified, Monitoring or Resolved) and a message.

An open incident raises the status of the components it affects to at least its impact: minor to Degraded performance, major to Partial outage, critical to Major outage. Posting Resolved closes it; it stays under Past incidents for 30 days.

Through the API you can also correct the text of an earlier update, though not its time or status, and report an incident after the fact with the time it started.

Announce maintenance​

When you create a maintenance window, select Announce on the status page and give it a Public title and, optionally, a Public description; see Plan a maintenance window. The window appears on the page of every entity whose components follow resources it covers: under Maintenance while it is in progress, otherwise its next occurrence within 30 days. A weekly window says it repeats instead of listing every week. Only the public title and description are shown, never the internal reason.

Serve the page on its own domain​

To publish the page as https://status.ciguapa.example/status/ciguapa:

  1. Point the name's DNS at the server, with a CNAME or an A record.
  2. Ask a super admin to add the name as an alias in Settings › Server and certificates, and, with a Let's Encrypt or own certificate, to keep it among the names in the certificate. See Set up names and TLS.
  3. Enter the name in the page's Own domain and select Save.

Links in the page and its feeds then use that name when the page is opened through it. The root of that name, https://status.ciguapa.example/, still opens the console's sign-in page, so share the full address with /status/<short name>.

Set a branch appearance​

Settings › Branch appearance sets a Default theme and a Logo address on an entity; every entity below it inherits them until it sets its own. In effect shows the result and where it comes from. A status page without a logo of its own uses its entity's logo. In this release the console itself does not apply a branch's theme yet; a person's own theme choice would win over it in any case.

Availability​

Every component records how long it spent in each status, per day of the page's time zone. Days with a daylight saving change have 23 or 25 hours. The bar shows one cell per day, 90 on a computer, 60 on a tablet and 30 on a phone, coloured by the worst status that lasted a minute or more that day, with details on hover, tap or keyboard focus.

  • Daily uptime = 1 − (major outage + 0.3 × partial outage) ÷ known time. Degraded performance counts as up. Maintenance and No data are left out of the known time, so planned work never lowers the figure.
  • The headline percentage uses the same formula over 90 days. A component created recently shows uptime since its first day.
  • A period with any downtime shows 99.99% at most, never 100%.
  • History is kept 400 days. A new time zone applies to new days; recorded days keep their boundaries.

Feeds and caching​

The page links to three feeds of its incident updates and announced maintenance: RSS 2.0, Atom 1.0 and JSON Feed 1.1, at /api/v1/status/<short name>/feed.rss, feed.atom and feed.json. Add ?lang=es for Spanish labels. E-mail subscriptions are not available yet.

The public addresses need no sign-in and are cheap to serve. The page answers with Cache-Control: public, max-age=30 and an ETag, the feeds with max-age=300, so a CDN or the proxy in front can cache them as they are. Responses carry Access-Control-Allow-Origin: *, so other sites can read the JSON.

Take the page offline​

  • To hide it for a while, clear Published and save. Its address answers not found at once.
  • Switching off the feature ui.public_status_page does the same for every page.
  • Delete the page removes it with its components, incidents and availability history. It cannot be undone.