Self-host Checkmate with Levelrail

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

  • Authorbluewave-labs
  • LicenceAGPL-3.0
  • Memory1 GiB
  • Archarm64
  • Services2

How to self-host Checkmate

  1. Pull the images

    2 images are pulled on your server.

    Show images
    • ghcr.io/bluewave-labs/checkmate-backend-mono-multiarch:v3.2.0
    • mongo:7
  2. Create the app

    2 services start in a single Compose app, with 1 named volume mount for your data, on port 52345.

  3. Fill in the secrets

    1 secret is generated and stored encrypted, 3 settings are preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Checkmate requirements

Memory
About 1 GiB
Architectures
amd64 image published, arm64 image published
Ports
52345
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
AGPL-3.0, network copyleft (agpl) license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 52345 on the host, so open them in the VPS firewall only if you want that.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Checkmate. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Checkmate docs page.

Deploy Checkmate your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Checkmate from the CLI

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

Deploy Checkmate with the API

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

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

Checkmate configuration

Checkmate services

ServiceImagePortsVolumes
checkmate ghcr.io/bluewave-labs/checkmate-backend-mono-multiarch:v3.2.0 52345 none
mongo mongo:7 none checkmate_mongo_data -> /data/db

Checkmate environment variables

VariableServiceValue
DB_CONNECTION_STRING checkmate Preset by the template
JWT_SECRET checkmate Generated at deploy
UPTIME_APP_API_BASE_URL checkmate Preset by the template
UPTIME_APP_CLIENT_HOST checkmate Preset by the template

Ports and volumes

Ports
52345
Volumes
1 named mount: checkmate_mongo_data -> /data/db

Checkmate FAQ

How much memory does Checkmate need?

The catalog lists about 1 GiB of memory for Checkmate across its 2 services.

Does Checkmate run on arm64?

For Checkmate, an arm64 image is published; amd64 is image published.

What licence is Checkmate under?

Checkmate is licensed under AGPL-3.0, which is network copyleft, so source sharing also applies when it is offered as a hosted service.

Does Checkmate need configuration before it starts?

No. The template fills in its own defaults and generates secrets at deploy time.

Which database does Checkmate bundle?

The template includes MongoDB, running as its own service.

Which ports does Checkmate use?

Checkmate listens on port 52345 inside the stack.

Where does Checkmate keep its data?

In a named volume: checkmate_mongo_data mounted at /data/db.

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.

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