Files
Checkmate/docs
gorkem-bwl 8e4e9dd87c fix(docs): make the build self-contained for Vercel
Vercel's "Root Directory" setting limits the upload to docs/api/, so
the build cannot read sibling paths like ../../server/openapi.json or
../api-content/. A small prebuild script copies both into a vendored
folder inside the project tree (gitignored).

## Changes
- Add scripts/sync-sources.mjs to copy /docs/api-content/ and
  /server/openapi.json into docs/api/src/vendored/ before dev/build
- Wire predev/prebuild npm scripts so the sync runs automatically
- Update astro.config.mjs and src/content.config.ts to read from the
  vendored paths
- Gitignore src/vendored/ — contributors still edit the originals
2026-05-22 14:20:10 -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