Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/healthchecks/dashboard
A standalone dashboard page showing the status of the checks in your Healthchecks.io account.
https://github.com/healthchecks/dashboard
cron devops monitoring
Last synced: 6 days ago
JSON representation
A standalone dashboard page showing the status of the checks in your Healthchecks.io account.
- Host: GitHub
- URL: https://github.com/healthchecks/dashboard
- Owner: healthchecks
- License: bsd-3-clause
- Created: 2019-07-06T15:01:54.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-13T07:03:17.000Z (3 months ago)
- Last Synced: 2024-08-13T08:26:04.075Z (3 months ago)
- Topics: cron, devops, monitoring
- Language: HTML
- Homepage:
- Size: 107 KB
- Stars: 85
- Watchers: 8
- Forks: 39
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - healthchecks/dashboard - A standalone dashboard page showing the status of the checks in your Healthchecks.io account. (HTML)
README
[](https://hub.docker.com/r/healthchecks/dashboard)
# Healthchecks.io Status Dashboard
A standalone dashboard page showing the status of the checks in your [Healthchecks.io](https://healthchecks.io)
account.
[See a live example dashboard here](https://cuu508.github.io/).
* Single page, no external dependencies.
* Plain HTML, JS and CSS. Fork it and hack on it – no build tools or dev environment needed.
* Live-updates every 5 seconds.
* Can display checks from multiple projects.
* Uses Healthchecks.io read-only API keys, does not expose ping URLs.
## Dark Theme
## Light Theme
## How To Use
* Fork the repository.
* Edit `index.html` and replace the API keys in `
` tags. Be sure to use the
**read-only** API keys!
* Optionally, you can tweak the colors, font sizes and layout.
* Publish the `index.html` file to a web server (Github pages, S3 bucket,
Netlify, ...), or simply open it as a local file in your browser.
## Specifying API Keys in the URL
As an alternative to editing `index.html`, the projects and their API keys can be
specified in the URL. Put them in the fragment identifier (after the "#" character) as
amperstand-delimited "apikey=title" pairs. Example:
index.html#UKsc30GIblRMKKN4BEPXcBNLa8bx4grU=Monitoring&uKatH7z6dSuN2Zyf1luRCmPDkw3fw2U0=Demo
The light theme is used by default, but the dark theme can also be specified
via the URL:
index.html#theme=dark
## Security
If you decide to make your dashboard public, your read-only API key will
become public as well. Using the read-only API key, anybody can fetch basic information
about checks in your project. This includes, for each check:
* name, **tags and description** (even though tags and descriptions are currently not
being shown on the dashboard)
* check's schedule (period, grace time, cron expression + timezone)
* current status (new / up / down / paused)
* precise time of the last ping
* precise time of when the next ping is expected
* total number of pings the check has received
Here are the things that the read-only API keys *cannot* do:
* the ping URLs are not exposed. You are not risking unexpected pings from random visitors
* no write access: cannot update or delete the existing checks, cannot create new checks
in your project
## Docker image
There is an official [Healthchecks.io Status Dashboard Docker image](https://hub.docker.com/r/healthchecks/dashboard)
on Docker Hub ready to use. The image is [automatically built](https://github.com/healthchecks/dashboard/actions/workflows/publish_docker_image.yml)
on each commit.
The image starts a lightweight [Caddy 2 Webserver](https://caddyserver.com/) with the
dashboard at the webserver's root. The example below starts a one-off, interactive
container serving on port 8080 (`CTRL+C` to stop it):
```
$ docker run --rm -it -p 8080:80 healthchecks/dashboard
```