selfhost.directory

The index of self-hostable projects — ranked, categorized and served with live updates.
Own your data and stop giving it to big tech.

Checkup logo

Self-host Checkup

v0.2.0

Distributed health checks and status pages

BetaOpen SourceMIT
Updatedlast month
LanguageGo
Setup difficultyModerate
MobileResponsive
Stars
3 461
Port
3000 (status page HTTP server)
Install with Docker Compose

What is Checkup?

Checkup is a self-hosted monitoring tool that performs distributed health checks on your services and generates status pages. It was created by the author of Caddy and is maintained by Sourcegraph. The tool runs on Linux, macOS, BSD, and Solaris. You configure checks, storage, and notifiers in a JSON file. It supports HTTP, TCP, DNS, TLS, and exec checkers with storage backends including Amazon S3, local filesystem, GitHub, MySQL, PostgreSQL, SQLite3, and Azure Application Insights. Notifications can be sent via Slack, email, Mailgun, or Pushover. The status page is mobile-responsive and can be served locally or hosted on GitHub Pages or S3. Checkup can run as a CLI tool, a Go library, or in a Docker container exposing port 3000. The latest release is v0.2.0 from 2017 (pre-release), and the project appears to have low recent activity.

Should you self-host Checkup?

Checkup scores 54/100 on selfhost.directory (how scoring works) and ranks #9 of 12 in Uptime Monitoring. It has 3 461 GitHub stars.

There was no stable release in the past 12 months, so check the repository's recent activity before you rely on it.

Setup is moderate: expect some configuration beyond a single command. It is MIT-licensed and written mostly in Go.

Its closest alternative on selfhost.directory is gatus (76/100, 12 428 stars). It scores higher overall, so compare the two before you pick. See Checkup vs gatus side by side.

Features

  • CLI and Go library
  • Custom checkers and storage
  • Data retention
  • Distributed checks
  • DNS health checks
  • Exec health checks
  • HTTP health checks
  • Lock-free design
  • Multiple Storage Backends
  • Notifications
  • Status messages
  • Status Page
  • TCP health checks
  • TLS health checks

Checkup README

How to install Checkup

Install Checkup with Docker Compose

version: '2.4'

services: checkup: hostname: checkup image: checkup:latest ports: - 3000 volumes: - ./checkup.json:/app/checkup.json - ./checks:/app/checks restart: always

Requires checkup.json and statuspage/ folder mounted

How to configure Checkup

  • checkersArray of checker configurations (HTTP, TCP, DNS, TLS, exec)

    Array of checker configurations (HTTP, TCP, DNS, TLS, exec)

  • notifiersArray of notifier configurations (Slack, mail, Mailgun, Pushover)

    Array of notifier configurations (Slack, mail, Mailgun, Pushover)

  • storageStorage backend configuration (S3, filesystem, GitHub, MySQL, PostgreSQL, SQLite3, Azure Application Insights)

    Storage backend configuration (S3, filesystem, GitHub, MySQL, PostgreSQL, SQLite3, Azure Application Insights)

Checkup releases & version history

More in Status Pages

Rate this project

Click to rate — no account needed.

0 comments

Posting as guest
Loading comments…