Self-host Checkmate on a VPS

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

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

Specification

Status
Listed
Category
Monitoring
Services
checkmate, mongo
Ports
52345
Volumes
1
Memory
about 1 GiB
arm64
image published
amd64
image published
Settings to fill in
none

About Checkmate

An open-source uptime and server monitoring app with incident history and status pages. Runs 2 containers (checkmate, mongo), with checkmate listening on port 52345; data is kept in named volumes.

What it deploys

Checkmate runs as 2 services in a single Compose app, listening on port 52345, with 1 named volume mount.

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

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.
  • Host ports. It publishes port 52345 directly on the host, so open them in the VPS firewall only if you want that.

Settings and environment

You do not have to fill in anything. 1 secret is generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
checkmateDB_CONNECTION_STRINGPreset by the template
checkmateJWT_SECRETGenerated at deploy
checkmateUPTIME_APP_API_BASE_URLPreset by the template
checkmateUPTIME_APP_CLIENT_HOSTPreset by the template

Install Checkmate on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get checkmate
  4. Deploy it

    This deploys the template compose file as an app. The app name defaults to the template id; --name sets another.

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

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Checkmate.

More in Monitoring

All Monitoring templates