Checkmate Documentation

Checkmate is an open-source, self-hosted tool designed to track and monitor server hardware, uptime, response times, and incidents in real-time with...

10,959 stars TypeScript TypeScript 13 files · ~17,545 tokens #good-first-contribution#good-first-issue#good-first-project#hacktoberfest#help-wanted#incident#infrastructure#infrastructure-monitoring
RAW Doc

Docker & Self-Hosted Deployment Verified OCI

Deploy Checkmate on any server, homelab, or cloud container platform.

1-Click Terminal Command
bash (docker run) 
docker run -d --name checkmate -p 8443:8443 --restart always nginx:alpine
Configured Services & Ports
⚙️ nginx-test
image: nginx:alpine
🔌 Ports: 8443:443
docker-compose.yml
yaml (docker-compose.yml) 
# Dev/Test only: Not required in production
# Docker Compose configuration for nginx test service

services:
  nginx-test:
    image: nginx:alpine
    ports:
      - "8443:443"
    volumes:
      - ../certs/host-int-cert.pem:/etc/nginx/certs/server.crt:ro
      - ../certs/host-int-key.pem:/etc/nginx/certs/server.key:ro
      - ./nginx.conf:/etc/nginx/nginx.conf:ro
    restart: unless-stopped

Checkmate Documentation

Welcome to the Checkmate documentation. This directory contains guides and references for various aspects of Checkmate deployment and configuration.

Available Documentation

Deployment & Configuration

Docker Configuration

Custom CA Trust

If you need to monitor internal HTTPS endpoints with certificates from private Certificate Authorities (like Smallstep), see our custom CA trust documentation:

Example Configurations

The docker/dev/ directory contains example configurations:

  • docker-compose.custom-ca-example.yaml - Example Docker Compose with custom CA

Contributing to Documentation

If you find issues or want to improve the documentation:

  1. Check existing issues and discussions
  2. Submit a pull request with your changes
  3. Follow the same markdown formatting style
  4. Include practical examples and code snippets

Getting Help

Explore Related Technologies & Topics

View All 9,111+ Repositories →

Discover similar high-velocity repositories, agent skills, and OpenAPI specifications across the ecosystem.

#good-first-contribution Browse good-first-contribution catalog → #good-first-issue Browse good-first-issue catalog → #good-first-project Browse good-first-project catalog → #hacktoberfest Browse hacktoberfest catalog → #help-wanted Browse help-wanted catalog → #incident Browse incident catalog → ⚡ MCP Servers Model Context Protocol → 🧠 Agent Skills Prompt & rule files → 🔌 OpenAPI Specs REST & Swagger schemas →