Portainer Templates logo

Portainer Templates

Checkmate Checkmate

Stack

Network

An open source uptime and infrastructure monitoring application.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

client

Configuration

Image
bluewaveuptime/uptime_client:latest
Ports
1180:8011443:443
Env vars
UPTIME_APP_API_BASE_URL=http://localhost:5000/api/v1
Restart
always

Image details

Pulls: 53.3k
User: bluewaveuptime
Created: Sep 23, 2024
Updated: 1 years ago
Status: active

server

Configuration

Image
bluewaveuptime/uptime_server:latest
Ports
5000:5000
Env vars
DB_CONNECTION_STRING=mongodb://mongodb:27017/uptime_dbREDIS_HOST=redis
Restart
always

Image details

Pulls: 55.6k
User: bluewaveuptime
Created: Sep 23, 2024
Updated: 1 years ago
Status: active

redis

Configuration

Image
bluewaveuptime/uptime_redis:latest
Ports
6379:6379
Volumes
/data : /portainer/Files/AppData/Config/checkmate/redis/data
Restart
always

Image details

Pulls: 54.2k
User: bluewaveuptime
Created: Sep 23, 2024
Updated: 1 years ago
Status: active

mongodb

Configuration

Image
bluewaveuptime/uptime_database_mongo:latest
Command
mongod,--quiet
Ports
27017:27017
Volumes
/data/db : /portainer/Files/AppData/Config/checkmate/mongo/data
Restart
always

Image details

Pulls: 52.3k
User: bluewaveuptime
Created: Sep 23, 2024
Updated: 1 years ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Checkmate

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Checkmate, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  client:
    image: bluewaveuptime/uptime_client:latest
    restart: always
    environment:
      UPTIME_APP_API_BASE_URL: "http://localhost:5000/api/v1"
    ports:
      - "1180:80"
      - "11443:443"
    depends_on:
      - server
  server:
    image: bluewaveuptime/uptime_server:latest
    restart: always
    ports:
      - "5000:5000"
    depends_on:
      - redis
      - mongodb
    environment:
      - DB_CONNECTION_STRING=mongodb://mongodb:27017/uptime_db
      - REDIS_HOST=redis
    # volumes:
    # - /var/run/docker.sock:/var/run/docker.sock:ro
  redis:
    image: bluewaveuptime/uptime_redis:latest
    restart: always
    ports:
      - "6379:6379"
    volumes:
      - /portainer/Files/AppData/Config/checkmate/redis/data:/data
    healthcheck:
      test: ["CMD", "redis-cli", "ping"]
      interval: 30s
      timeout: 10s
      retries: 5
      start_period: 5s
  mongodb:
    image: bluewaveuptime/uptime_database_mongo:latest
    restart: always
    volumes:
      - /portainer/Files/AppData/Config/checkmate/mongo/data:/data/db
    command: ["mongod", "--quiet"]
    ports:
      - "27017:27017"

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/checkmate.yml up -d

More install options in our documentation.

Serve Checkmate on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying checkmate.example.com to http://client:80

Add this to your Caddyfile

checkmate.example.com {
	reverse_proxy http://client:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:1180 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :1180
  • Stop the other service, or pick a different host port. In 1180:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:1180. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, checkmate can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 1180

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/checkmate/redis/data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull bluewaveuptime/uptime_client:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Checkmate is a Compose stack, a set of containers (4 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 4 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • client runs bluewaveuptime/uptime_client:latest, starts after server
  • server runs bluewaveuptime/uptime_server:latest, starts after redis, mongodb
  • redis runs bluewaveuptime/uptime_redis:latest
  • mongodb runs bluewaveuptime/uptime_database_mongo:latest

Ports

A port is the door the app answers on. A mapping like 1180:80 means it's reachable on port 1180 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:1180 in a browser. It opens:

  • 1180:80, likely the web interface
  • 11443:443, likely the web interface
  • 5000:5000
  • 6379:6379
  • 27017:27017

Volumes

A volume is where Checkmate keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data from /portainer/Files/AppData/Config/checkmate/redis/data on the host
  • /data/db from /portainer/Files/AppData/Config/checkmate/mongo/data on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Checkmate takes 3 of them, all with defaults you can leave alone or tweak:

  • UPTIME_APP_API_BASE_URL, defaults to http://localhost:5000/api/v1
  • DB_CONNECTION_STRING, defaults to mongodb://mongodb:27017/uptime_db
  • REDIS_HOST, defaults to redis

Restart policy

The restart policy here is always, so Docker brings Checkmate back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like client) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Checkmate up. Add the template list to Portainer once, then deploying Checkmate is a click rather than a wall of config.