Skip to content
Guides

The status page and badge

A project can have two things the public can see: a status page that says whether it's up, and a badge with its verified MRR. Both stay off until you publish them, and either can be revoked at once.

Owners, admins and the project's editors see Settings → Public. The badge is there only if you can also see the project's amounts. Viewers don't have this section: its address gives Page not found.

Open it

  1. Open the project and press Settings.
  2. Press Public.

The page says "Everything here stays off until you publish it.", and how much of your plan is in use: "0 of 10 public pages on your plan are in use." Each part shows Off, Public or, for an archived project, Not served.

Publish a status page

  1. Under Status page, check the Page name and the Address. The full address shows under the field, as in https://…/s/atlas.
  2. Under Checks to show, tick the checks to list. A project with none says "This project has no checks yet. Add a domain under Surfaces."
  3. Give each a Public name, such as "Website". "Each one appears under a public name. Its address is never shown."
  4. Leave Show incident history ticked to show the last 30 days of incidents, or untick it.
  5. Tick Allow search engines to index if you want it found. It's off by default.
  6. Show the footer link shows only on plans that may remove it.
  7. Press Publish status page. The page says "Your status page is public at /s/atlas."

A preview of the page appears, "This is the page as it's served now." Open the status page opens it in a new tab.

To change it later, edit the form and press Save changes. Until you save, the preview says "This is the page as it's served now. Save to see your changes here."

What readers see

The project's name, one sentence ("All systems operational", "Checkout is down", "Some systems degraded", or "Waiting for first results"), each check under its public name with its 90-day strip and percentage, Current incidents with any public note, and Past 30 days. The page works in light and dark themes and needs no JavaScript.

Publish a badge

The badge shows MRR read from a provider's API, so a project with manual or invoice revenue can't have one: "Only MRR read from a provider's API can be verified, so a project with manual or invoice revenue can't have a badge."

  1. Under Verified MRR badge, choose Rounded ("Rounded keeps two significant figures.") or Exact under Figure.
  2. Choose Dark, Light or Outline under Style.
  3. Read exactly what goes public: "Anyone with the badge will see Atlas' MRR, rounded: $4.2k MRR. Updated daily. You can turn it off at any time."
  4. Press Publish badge. The page says "Your badge is public. Copy it from Embed below."

The badge and a preview of its page appear. Open the badge's page opens the page behind it: the 12-month trend and the date of the last sync.

Under Embed, choose Markdown or HTML and press Copy the embed code. Paste it into your README or site.

To change it, choose again and press Save changes.

Revoke

A status page:

  1. Press Revoke status page.
  2. The page asks "Revoke this status page?": "/s/atlas answers 404 at once. Your settings stay, so you can publish it again."
  3. Press Revoke status page to confirm, or Cancel.
  4. The page says "Status page revoked. /s/atlas now answers 404."

A badge:

  1. Press Revoke badge.
  2. The page asks "Revoke this badge?": "Wherever it's embedded it turns into a neutral “badge disabled”, and its page answers 404, at once. Its address never comes back: a new badge gets a new one."
  3. Press Revoke badge to confirm, or Cancel.
  4. The page says "Badge revoked. Wherever it's embedded, it now reads “badge disabled”."

Revoking gives the place on your plan back.

An archived project

An archived project's public pages answer 404 and its badge reads "badge disabled". A page you don't revoke keeps its place on your plan, and comes back if the project is unarchived. Public offers only Revoke. A proposed project has none: it waits until it's confirmed.

When it doesn't work

  • The page says
    "Give the page a name."
    What to do
    Type a Page name.
  • The page says
    "Use 2 to 48 lowercase letters, digits and hyphens, starting with a letter or digit."
    What to do
    Change the Address.
  • The page says
    "That address is taken. Try another."
    What to do
    Choose another Address.
  • The page says
    "Choose at least one check."
    What to do
    Tick a check.
  • The page says
    "Give this check a public name."
    What to do
    Type its Public name.
  • The page says
    "A page shows up to 12 checks."
    What to do
    Untick one to add another.
  • The page says
    "A check on this page no longer exists. Review the list and try again."
    What to do
    Look over Checks to show and save again.
  • The page says
    "Your plan includes 10 public pages. Revoke one, or see plans."
    What to do
    Revoke another page, or change plan.
  • The page says
    "Your plan keeps the footer on public pages."
    What to do
    Keep Show the footer link.
  • The page says
    "Only MRR read from a provider's API can be verified."
    What to do
    The project has manual or invoice revenue.
  • The page says
    "That wasn't saved. Try again."
    What to do
    Try again.
  • The page says
    "That wasn't revoked, so it's still public. Try again."
    What to do
    Press Revoke … again. It's still public until you see the line above.
  • The page says
    "This section didn't load."
    What to do
    Reload the page.