You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add relevant tags to the checks you want to display on your dashboard
23
+
<Steptitle="Add tags to checks and monitors">
24
+
Add relevant tags to all the checks and monitors that you'd like to display on your dashboard.
25
+
25
26
</Step>
26
27
27
28
<Steptitle="Create Dashboard">
28
-
Set up a new dashboard and configure basic settings
29
+
Create a new dashboard and configure basic settings.
29
30
</Step>
30
31
31
-
<Steptitle="Apply Tag Filters">
32
-
Specify which tags should determine dashboard content
32
+
<Steptitle="Apply tag filters">
33
+
Add tags to your dashboard to specify which checks to show.
33
34
</Step>
34
35
35
-
<Steptitle="Customize Appearance">
36
-
Configure branding, colors, and layout options
36
+
<Steptitle="Customize appearance (optional)">
37
+
Customize your dashboard's look and feel using custom CSS rules.
37
38
</Step>
38
39
39
-
<Steptitle="Set Up Custom Domain">
40
-
Optionally configure a custom domain for professional branding
40
+
<Steptitle="Set up a custom domain (optional)">
41
+
Optionally configure a custom domain for professional branding.
41
42
</Step>
42
43
43
-
<Steptitle="Test and Share">
44
-
Verify dashboard functionality and share with intended audience
44
+
<Steptitle="Share the URL">
45
+
Once your dashboard is ready, you can share it with anyone using its URL.
45
46
</Step>
46
47
</Steps>
47
48
49
+
## Basic Settings
48
50
49
-
## Dashboard Privacy and Access Control
51
+
-**Title:** Add a title like "ACME status dash". This is separate from your Checkly URL or custom domain.
52
+
-**Description:** Add a clarifying text to explain to visitors what they are looking at.
53
+
-**Checks:** Specify the tags of the checks you want to show on the dashboard. By default we show all checks.
54
+
You can also choose to hide the tags from the dashboard.
50
55
51
-
By default, Checkly dashboards are public and accessible to anyone with the URL. You can restrict access by enabling password protection or Checkly account authentication.
56
+
## Checkly URL
52
57
53
-
> **Plan Requirements**: Private dashboards are available on Team and Enterprise plans. Checkly account login is exclusive to Enterprise customers.
58
+
Every dashboard comes with a configurable custom subdomain under the `checkly-dashboards.com` domain. By default,
59
+
we generate a random ID. You can change this subdomain to anything you like as long as it is unique among all Checkly users.
60
+
Typically, a company name works best, e.g. `acme.checkly-dashboards.com`
54
61
55
-
### Setting Up Password Protection
62
+
<Frame>
63
+
<img
64
+
className="block dark:hidden"
65
+
src="/images/next/dashboard-url-light.png"
66
+
alt="Light mode interface"
67
+
/>
68
+
<img
69
+
className="hidden dark:block"
70
+
src="/images/next/dashboard-url-dark.png"
71
+
alt="Dark mode interface"
72
+
/>
73
+
</Frame>
56
74
57
-
<Steps>
58
-
<Steptitle="Navigate to Dashboard Settings">
59
-
Go to the dashboard you want to protect and access its settings
60
-
</Step>
75
+
## Custom Domain
61
76
62
-
<Steptitle="Enable Password Protection">
63
-
Toggle on password protection and click "Save" to apply changes
64
-
</Step>
77
+
You can host your dashboard under your own domain. To make this work, you need to do two things:
65
78
66
-
<Steptitle="Generate Password">
67
-
Click the "Generate Password" button that appears after saving
68
-
</Step>
79
+
1. Add a valid custom domain to your dashboard setting.
69
80
70
-
<Steptitle="Secure Your Password">
71
-
Copy the password from the modal - **this is the only time you'll see it in plaintext**
72
-
</Step>
73
-
</Steps>
81
+
<Frame>
82
+
<img
83
+
className="block dark:hidden"
84
+
src="/images/next/dashboard-domain-light.png"
85
+
alt="Light mode interface"
86
+
/>
87
+
<img
88
+
className="hidden dark:block"
89
+
src="/images/next/dashboard-domain-dark.png"
90
+
alt="Dark mode interface"
91
+
/>
92
+
</Frame>
93
+
94
+
2. Create a CNAME record in your DNS that points to **checkly-dashboards.com**
95
+
96
+
Any DNS provider will have the option to easily add CNAME records. For example, on AWS Route 53 this looks as follows.
74
97
75
-
<Warning>
76
-
**Important**: We don't store passwords in plaintext. If lost, you'll need to generate a new password and update all users with the new credentials.
By default, Checkly dashboards are public and visible to anyone who knows the URL. You can set a dashboard to private, limiting access to users with a password or Checkly account.
80
130
81
-
Protected dashboards work with both access methods:
131
+
### Enabling Authentication
82
132
83
-
**Password Authentication** (Team and Enterprise plans)
84
-
- Available on custom domains and default `https://[dashboardId].checkly-dashboards.com` URLs
85
-
- Use the generated password to access the dashboard
133
+
<Note>
134
+
Private dashboards are only available on certain plans. For more details, see our [Pricing page](https://www.checklyhq.com/pricing).
135
+
</Note>
86
136
87
-
**Checkly Account Login** (Enterprise only)
88
-
- Available only on default `https://[dashboardId].checkly-dashboards.com` URLs
89
-
- Click "Login with Checkly" and sign in with your existing account
90
-
- Supports all authentication methods (Google, GitHub, username/password)
137
+
To enable authentication on a dashboard:
91
138
139
+
1. Navigate to the settings of the dashboard you wish to modify.
140
+
2. Toggle on the "Password Protection" setting.
141
+
3. Click "Save" to apply the changes.
142
+
4. Next, the "Generate Password" button will appear, click this. It will open a modal which shows you your new private dashboard password.
92
143
93
144
<Warning>
94
-
Remember that dashboards are public by default. Always review which checks and data you're exposing before sharing dashboard URLs with external audiences.
145
+
Be careful, **this is the only time you will see this password in plaintext**. We do not store the password in plaintext, so if it is ever lost, you will need to regenerate a new one and inform any users of the new credentials.
95
146
</Warning>
96
147
148
+
### Accessing Private Dashboards
149
+
150
+
After enabling password protection for your dashboard, you can continue to visit it via any custom domain you may have enabled, as well as the default `https://[dashboardId].checkly-dashboards.com` domain. The password authentication will work via both channels.
151
+
152
+
<Note>
153
+
Checkly account login is only available to Enterprise customers.
154
+
</Note>
155
+
156
+
If visiting via the `https://[dashboardId].checkly-dashboards.com` domain, you can also select "Login with Checkly" and sign in with your existing Checkly account via any of the supported methods (i.e. Google, Github, Username and Password). This is an Enterprise-only feature.
157
+
158
+
## Look and Feel
159
+
160
+
-**Logo:** Display your company logo (or any image) on the top left side of your dashboard.
161
+
-**Logo link:** Add a clickable destination URL for your logo. When visitors click the logo, they’ll be redirected to your specified website (typically your company homepage).
162
+
-**Favicon:** Set a custom favicon for browser tabs and bookmarks.
163
+
-**Auto paginate:** Automatically switch between dashboard pages when you have multiple pages of checks.
164
+
-**Auto refresh:** Set how often the dashboard refreshes—choose between 1, 5, or 10 minutes.
165
+
-**Show header:** Toggle visibility of the dashboard’s title and description.
166
+
-**Show check run links:** Adds a clickable link to each check result so team members can inspect them. Off by default.
167
+
-**Show and hide P-stats:** Toggle the visibility of the performance stats for all checks on the dashboard.
97
168
169
+
Next to the preset tweaks you can do to your dashboard, you can also apply [custom CSS styles](/communicate/dashboards/custom-css).
0 commit comments