Files
Checkmate/docs
gorkem-bwl a2786a77ec refactor(status-page): tighten the theme-fields backend after second review
Apply review feedback:
- Extract makeStatusPage from the two test files that duplicated it (test/unit/services/statusPageService.test.ts and test/unit/controllers/statusPageThemeFlag.test.ts) into test/helpers/makeStatusPage.ts. Both files now import the shared helper, matching the existing test/helpers/ convention used for repository fakes and provider contracts
- Add a blank line in statusPageController.getStatusPageByUrl between the normalizedMonitors map and the themesEnabled lookup so the response-shaping section breathes a bit
- Drop the obsolete localStorage references from the plan doc that survived from an earlier draft of the design — the public page never persisted a per-visitor mode choice in localStorage, so the test bullet under 2.11 and the risk row both pointed at functionality that does not exist
2026-04-27 19:33:03 -04:00
..

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
  • server-custom-ca.Dockerfile - Example Dockerfile for OS-level CA trust
  • export-smallstep-ca.sh - Helper script for Smallstep CA export

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