# Self-host Checkmate

> An open-source uptime and server monitoring app with incident history and status pages.

- Page: https://levelrail.com/templates/checkmate/
- JSON: https://levelrail.com/templates/checkmate.json
- Category: Monitoring
- Licence: AGPL-3.0 (Network copyleft (AGPL) license)
- Source: https://github.com/bluewave-labs/Checkmate
- Upstream docs: https://docs.checkmate.so

## Requirements
- Memory: about 1 GiB
- amd64: published, arm64: published
- Needs configuration before start: no
- Pinned image tag: v3.2.0

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| checkmate | ghcr.io/bluewave-labs/checkmate-backend-mono-multiarch | v3.2.0 | 52345 | none |
| mongo | mongo | 7 | none | checkmate_mongo_data -> /data/db |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| checkmate | DB_CONNECTION_STRING | preset |
| checkmate | JWT_SECRET | generated |
| checkmate | UPTIME_APP_API_BASE_URL | preset |
| checkmate | UPTIME_APP_CLIENT_HOST | preset |

## Deploy

### CLI

```bash
levelrail-cli templates deploy checkmate --name my-checkmate
```

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" \
  https://levelrail.example.com/api/v1/service-templates/checkmate/deploy
```

Create a token in the dashboard first. This one-click route deploys it as a trial app you can keep or remove.

## Questions

### Can I deploy Checkmate on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id checkmate for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image ghcr.io/bluewave-labs/checkmate-backend-mono-multiarch:v3.2.0, mongo:7 is what you deploy there.

Self-host Checkmate, Checkmate docker compose file, deploy Checkmate on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
