Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions communicate/status-pages/custom-domain.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: "Custom domain"
description: "Add a custom domain to your status page."
sidebarTitle: "Custom Domain"
canonical: 'https://www.checklyhq.com/docs/communicate/status-pages/custom-domain/'
---

You can host your status page on your own domain. To set it up, add the domain in Checkly and create the required DNS records with your DNS provider.

<Note>
Custom domains are available on Communicate Starter, Team and Enterprise
plans. [View pricing](https://checklyhq.com/pricing)
</Note>

<Steps>
<Step title="Add a custom domain to your Status Page">
![Custom domain configuration](/images/docs/images/status-pages/status-pages-custom-domain-1.png)
</Step>

<Step title="Create a CNAME record that points to `custom-slug.checkly-status-page.com`">
Create a CNAME record with your DNS provider and point it to
`custom-domain.checkly-status-page.com` For example, in Cloudflare, the
configuration looks like this: ![Custom domain CNAME
configuration](/images/docs/images/status-pages/status-pages-custom-domain-2.png)
If your provider is Cloudflare, you must disable the proxy on the CNAME, it
should always be set to DNS only.
</Step>

<Step title="Add TXT record(s) to perform validation and prove domain ownership">
After you've added your custom domain and saved the page, one or more TXT records will be displayed depending on the domain you're using.
![Example custom domain TXT configuration](/images/docs/images/status-pages/status-pages-custom-domain-3.png)

Update your DNS settings to match the TXT record(s) displayed on your Status Page to prove the ownership of the domain.

<Note>
Search engines require this verification to index and list your Status Page.
</Note>
</Step>
</Steps>
70 changes: 35 additions & 35 deletions communicate/status-pages/customization.mdx
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
---
title: "Status Page Customization"
description: "Add a custom domain and look & feel to your Status Page."
description: "Change the logo, favicon, theme, and colors of your status page to match your brand."
sidebarTitle: "Customization"
canonical: 'https://www.checklyhq.com/docs/communicate/status-pages/customization/'
---

## Custom domain
You can change how your status page looks and match it to your branding. Add your logo and favicon, pick a light or d
ark theme, and override the colors used across the page.

<Note>
Custom domains are available on Communicate Starter, Team and Enterprise
plans. [View pricing](https://checklyhq.com/pricing)
Theme customization is available on Communicate Team and Enterprise plans.
[View pricing](https://checklyhq.com/pricing)
</Note>

You can host your Status Page on your own domain. To set it up, add the domain in Checkly and create the required DNS records with your DNS provider.
## Logo and favicon

<Steps>
<Step title="Add a custom domain to your Status Page">
![Custom domain configuration](/images/docs/images/status-pages/status-pages-custom-domain-1.png)
</Step>
Put your own brand front and center. Your logo sits at the top of every page view, and your favicon makes the page easy to spot in a crowded tab bar. Both are set by URL, so host the image files somewhere publicly reachable first.

<Step title="Create a CNAME record that points to `custom-slug.checkly-status-page.com`">
Create a CNAME record with your DNS provider and point it to
`custom-domain.checkly-status-page.com` For example, in Cloudflare, the
configuration looks like this: ![Custom domain CNAME
configuration](/images/docs/images/status-pages/status-pages-custom-domain-2.png)
If your provider is Cloudflare, you must disable the proxy on the CNAME, it
should always be set to DNS only.
</Step>
- **Logo**: your primary brand mark, displayed in the page header. Use a PNG, JPG, or SVG with a roughly 5:3 aspect ratio for the best fit.
- **Dark mode logo**: an alternative version shown when the page is in dark mode, so your logo looks sharp on both light and dark backgrounds.
- **Logo redirects user to**: where visitors go when they click your logo. Point it at your website to keep them close to your product.
- **Favicon**: the icon in the browser tab and bookmarks. Use a PNG, ICO, or SVG.

<Step title="Add TXT record(s) to perform validation and prove domain ownership">
After you've added your custom domain and saved the page, one or more TXT records will be displayed depending on the domain you're using.
![Example custom domain TXT configuration](/images/docs/images/status-pages/status-pages-custom-domain-3.png)
## Theme

Update your DNS settings to match the TXT record(s) displayed on your Status Page to prove the ownership of the domain.
Choose the look that suits your brand, or let each visitor decide:

<Note>
Search engines require this verification to index and list your Status Page.
</Note>
</Step>
</Steps>
- **Auto**: matches the visitor's system preference, so the page always feels native.
- **Light**: a clean, bright layout for every visitor.
- **Dark**: a darker layout for every visitor.

## Customize your Status Page to match your brand identity
## Custom theme colors

- Upload your company logo and the link it should open
- Upload a custom favicon
- Choose the default theme: auto (system), light or dark
- Customize the color theme to match your brand
Go beyond a logo and make the whole page yours. Every major surface and text color can be overridden to match your
brand guidelines, with separate palettes for light and dark mode under the **Light** and **Dark** tabs.

<Note>
Theme customization is available on Communicate Team and Enterprise plans.
[View pricing](https://checklyhq.com/pricing)
</Note>
![Status page customizaztion example](/images/docs/images/status-pages-v3/status_page_v3_custom_1.jpg)

| Color | Where it's used |
|-------|-----------------|
| Body background | Background of the page body |
| Header background | Background of the page header |
| Header font | Main header text, such as your company name |
| Title font | Titles on the page |
| Body font | Regular body text |
| Body font (muted) | Secondary text, such as timestamps |
| Navigation font | Navigation links in the header |
| Link font | Links within the page content |
| Card background | Component and incident cards |
| Border | Divider below the header and card borders |
| Primary button background | Primary buttons, such as **Get updates** |
| Primary button font | Text on primary buttons |
22 changes: 11 additions & 11 deletions communicate/status-pages/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ Components belong to one status page. You manage them in the page's settings, wh

Each component has one of five statuses:

| Status | Meaning |
|--------|---------|
| Operational | Everything works |
| Under maintenance | Planned maintenance is running |
| Degraded performance | Slow, but working |
| Partial outage | Some functionality is unavailable |
| Major outage | The component is down |
| Status | Meaning | Uptime calculation |
|--------|---------|--------------------|
| Operational | Everything works | N/A |
| Under maintenance | Planned maintenance is running | 0% |
| Degraded performance | Slow, but working | 0% |
| Partial outage | Some functionality is unavailable | 30% |
| Major outage | The component is down | 100% |

A component's status is set by open [incidents](/communicate/status-pages/incidents): each incident declares an impact per affected component. The page header shows the worst status across all components.

Expand All @@ -54,10 +54,10 @@ Incident automation is available on Communicate Team and Enterprise plans. [View

Uptime is calculated over the **last 90 days**, per component, from incident impacts:

- **Major outage** time counts as full downtime.
- **Partial outage** time counts as 30% downtime.
- **Degraded performance** and **under maintenance** do not lower uptime.

- **Major outage** counts as 100% downtime.
- **Partial outage** counts as 30% downtime.
- **Degraded performance** counts as 0% downtime as the service is still usable.
- **Under maintenance** counts as 0% downtime as it is an intentional pause of service.
```
Uptime = ((Total time - Weighted downtime) / Total time) × 100
```
Expand Down
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -291,6 +291,7 @@
"pages": [
"communicate/status-pages/overview",
"communicate/status-pages/creating-a-status-page",
"communicate/status-pages/custom-domain",
"communicate/status-pages/customization",
"communicate/status-pages/password-protection",
"communicate/status-pages/incidents",
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/docs/images/status-pages-v3/status_page_v3_public.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions sitemap.xml
Original file line number Diff line number Diff line change
Expand Up @@ -882,6 +882,9 @@
<url>
<loc>https://www.checklyhq.com/docs/communicate/status-pages/creating-a-status-page/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/communicate/status-pages/custom-domain/</loc>
</url>
<url>
<loc>https://www.checklyhq.com/docs/communicate/status-pages/customization/</loc>
</url>
Expand Down
Loading