This repository contains both the frontend and the backend of Checkmate, an open-source, self-hosted monitoring tool for tracking server hardware, uptime, response times, and incidents in real-time with beautiful visualizations. Checkmate regularly checks whether a server/website is accessible and performs optimally, providing real-time alerts and reports on the monitored services' availability, downtime, and response time.
Checkmate also has an agent, called Capture, to retrieve data from remote servers. While Capture is not required to run Checkmate, it provides additional insights about your servers' CPU, RAM, disk, and temperature status. Capture can run on Linux, Windows, Mac, Raspberry Pi, or any device that can run Go.
🚀 Proven at scale
Checkmate is used in production to monitor 1,600+ servers on a single deployment.
✅ No reported performance bottlenecks
✅ No significant operational issues
Checkmate also scales horizontally for more than 5000 servers: you can run dedicated worker nodes that share the check load through MongoDB.
📚 Table of contents
Demo
You can see the latest build of Checkmate in action.
The username is [email protected] and the password is Demouser1! (just a note that we update the demo server from time to time, so if it doesn't work for you, please ping us on the Discussions channel).
User's guide
Usage instructions can be found here.
Prerequisites
- Docker with Docker Compose installed
- Git only if you want to build the image yourself
Installation
The quickest way to run Checkmate is the reference Docker Compose file. It starts two services: the all-in-one Checkmate application image (ghcr.io/bluewave-labs/checkmate) and a separate MongoDB service.
What “all-in-one” means: the Checkmate application is packaged in a single image; MongoDB is not embedded in that image and remains required. The reference Compose file starts MongoDB for you. For custom deployments, configure DB_CONNECTION_STRING to use an external MongoDB instance.
curl -O https://raw.githubusercontent.com/bluewave-labs/checkmate/master/docker/docker-compose.yaml
JWT_SECRET="$(openssl rand -hex 32)" docker compose up -d
Then open http://localhost:52345. If the app is reached at another origin (domain or LAN IP), set CLIENT_HOST accordingly. To build the image yourself, run docker build -f docker/Dockerfile -t checkmate . from a checkout. For TLS, put any reverse proxy (Caddy, Traefik, nginx) in front of port 52345.
Install with one click
You can also run Checkmate on any of these platforms:
Note that the Helm chart has not yet been migrated to the all-in-one image: it still deploys the legacy checkmate-client, checkmate-backend and checkmate-mongo images, pinned at v3.8.1.
Configuration
The image is configured entirely through environment variables on the server container:
This is the beginning of the README. Read the rest at the original. Read the full README ↗
