Giter VIP home page Giter VIP logo

hc-dashboard's Introduction

Docker Pulls

Healthchecks.io Status Dashboard

A standalone dashboard page showing the status of the checks in your Healthchecks.io account.

See a live example dashboard here.

  • 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

Dark THeme

Light Theme

Light THeme

How To Use

  • Fork the repository.
  • Edit index.html and replace the API keys in <h1> 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 on Docker Hub ready to use. The image is automatically built on each commit.

The image starts a lightweight Caddy 2 Webserver 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

hc-dashboard's People

Contributors

cuu508 avatar pataquets avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.