How to Install Checkmate on Your Synology NAS

by

How to Install Checkmate on Your Synology NAS

Checkmate is an open-source, self-hosted monitoring tool designed to track server hardware, uptime, response times, and incidents in real-time with beautiful visualizations. It’s an alternative to Uptime Kuma. It supports diverse checks including Docker, ping, SSL, ports, game servers, and page speed, plus optional infrastructure metrics via a lightweight agent, customizable status pages, incident tracking, and alerts across email, Discord, Slack, and more. In this step by step guide I will show you how to install CheckmateĀ on your Synology NAS using Docker & Portainer. āš ļøNote: This guide works only on a Synology NAS that supports AVX.

šŸ’”Note:Ā This guide works perfectly with the latest Checkmate v3.7.1 release.

  • STEP 1

Please Support My work by Making a Donation.

  • STEP 2

InstallĀ Portainer using my step by step guide. If you already have Portainer installed on your Synology NAS, skip this STEP. Attention: Make sure you have installed the latest Portainer version.

  • STEP 3

Make sure you have a synology.me Wildcard Certificate. Follow my guide to get a Wildcard Certificate. If you already have a synology.me Wildcard certificate, skip this STEP.

  • STEP 4

Go toĀ Control PanelĀ /Ā Login PortalĀ /Ā AdvancedĀ Tab / clickĀ Reverse Proxy. Follow the instructions in the image below.

Checkmate Synology NAS Set up 1

  • STEP 5

Now click the ā€œCreateā€ button. Follow the instructions in the image below.

Checkmate Synology NAS Set up 2

  • STEP 6

After you click the Create button, the window below will open. Follow the instructions in the image below.

On the General area, set the Reverse Proxy Name description: type in Checkmate. After that, add the following instructions:

Source:
Protocol:Ā HTTPS
Hostname: checkmate.yourname.synology.me
Port:Ā 443

Check Enable HSTS

Destination:
Protocol:Ā HTTP
Hostname:Ā localhost
Port:Ā 52345

Checkmate Synology NAS Set up 3

  • STEP 7

On the Reverse Proxy Rules, click the Custom HeaderĀ tab. ClickĀ CreateĀ and then, from the drop-down menu, clickĀ WebSocket. After you click on WebSocket, two Header Names and two Values will be automatically added. ClickĀ Save. Follow the instructions in the image below.

Synology Proxy WebSocket

  • STEP 8

Go to Control Panel / Network / Connectivity tab/ Check Enable HTTP/2 then click Apply. Follow the instructions in the image below.

Checkmate Synology NAS Set up 4

  • STEP 9

Go to Control Panel / Security / Advanced tab/ Check Enable HTTP CompressionĀ then click Apply. Follow the instructions in the image below.

Checkmate Synology NAS Set up 5

  • STEP 10

Go toĀ File StationĀ and open the docker folder. Inside the docker folder, create one new folder and name itĀ checkmatedb. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Checkmate Synology NAS Set up 6

  • STEP 11

Log into Portainer using your username and password. On the left sidebar in Portainer, click onĀ HomeĀ thenĀ Live connect. Follow the instructions in the image below.

Portainer Add Stack NAS 1

On the left sidebar in Portainer, click on StacksĀ thenĀ + Add stack. Follow the instructions in the image below.

Portainer Add Stack NAS 2

  • STEP 12

In the Name field type in checkmate. Follow the instructions in the image below.

Note: Copy Paste the code below in the Portainer Stacks Web editor.

services:
  checkmate:
    image: ghcr.io/bluewave-labs/checkmate-backend-mono:latest
    container_name: Checkmate
    healthcheck:
      test: timeout 10s bash -c ':> /dev/tcp/127.0.0.1/52345' || exit 1
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    ports:
      - 52345:52345
    environment:
       UPTIME_APP_CLIENT_HOST: https://checkmate.yourname.synology.me
       CLIENT_HOST: https://checkmate.yourname.synology.me
       UPTIME_APP_API_BASE_URL: https://checkmate.yourname.synology.me/api/v1
       DB_CONNECTION_STRING: mongodb://mongodb:27017/uptime_db
       JWT_SECRET: dOxZYTTZgXKMHkqLBIQVImayQXAVWdzGBPuFJKggzcgvgPJPXpWzqzKaUOIOGGIr
    depends_on:
      - mongodb
    restart: on-failure:5
    
  mongodb:
    image: ghcr.io/bluewave-labs/checkmate-mongo:latest
    container_name: Checkmate-DB
    user: 1026:100
    command: ["mongod", "--quiet", "--bind_ip_all"]
    volumes:
      - /volume1/docker/checkmatedb:/data/db:rw
      - /volume1/docker/checkmatedb:/data/configdb:rw
    healthcheck:
      test: echo 'db.runCommand("ping").ok' | mongosh localhost:27017/test --quiet
      interval: 10s
      timeout: 10s
      start_period: 40s
      retries: 5
    restart: on-failure:5

Note: Before you paste the code above in the Web editor area below, change the value for UPTIME_APP_CLIENT_HOSTĀ and type in your own synology.me DDNS withĀ https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for CLIENT_HOSTĀ and type in your own synology.me DDNS withĀ https:// at the beginning that you have previously created at STEP 6.
Note: Before you paste the code above in the Web editor area below, change the value for UPTIME_APP_API_BASE_URLĀ and type in your own synology.me DDNS withĀ https:// at the beginning that you have previously created at STEP 6 followed by /api/v1
Note: Before you paste the code above in the Web editor area below, change the value for JWT_SECRET. (Generate your own Random 64 length JWT_SECRET.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for user with your own UID and GID values. (Follow my step by step guide on how to do this.) 1026 is my personal UID value and 100 is my personal GID value. You have to type in your own values.

Checkmate Synology NAS Set up 7

  • STEP 13

Scroll down on the page until you see a button namedĀ Deploy the stack. Click on it. Follow the instructions in the image below. The installation process can take up to a few minutes. It will depend on your Internet speed connection.

Checkmate Synology NAS Set up 8

  • STEP 14

If everything goes right, you will see the following message at the top right of your screen: ā€œSuccess Stack successfully deployedā€œ.

Portainer Success Stack NAS

  • STEP 15

šŸŸ¢Please Support My work by Making a Donation. Almost 99,9% of the people that install something using my guidesĀ forget to support my work, or justĀ ignoreĀ STEP 1. Iā€™ve been very honest about this aspect of my work since the beginning: I donā€™t run any ADS, I donā€™t require subscriptions, paid or otherwise, I donā€™t collect IPs, emails, and I donā€™t have any referral links from Amazon or other merchants. I also donā€™t have any POP-UPs or COOKIES. I have repeatedly been told over the years how much I have contributed to the community. Itā€™s something I love doing and have been honest about my passion since the beginning. But I also Need The Community to Support me Back to be able to continue doing this work.

  • STEP 16

Now open your browser and type in your HTTPS/SSL certificate like this https://checkmate.yourname.synology.me In my case it’s https://checkmate.mariushosting.synology.me If everything goes right, you will see the Checkmate registration page. Type in your own details, then click Register. Follow the instructions in the image below.

Checkmate Synology NAS Set up 9

  • STEP 17

On the left sidebar, click Uptime. Click Create a monitor. Follow the instructions in the image below.

Checkmate Synology NAS Set up 10

  • STEP 18

Add your own website details that you want to monitor. Click Save. Follow the instructions in the image below.

Checkmate Synology NAS Set up 11

  • STEP 19

Click on your Website name. Follow the instructions in the image below.

Checkmate Synology NAS Set up 12

  • STEP 20

In this area, you will see your website monitor with all the detailed stats at a glance! Go straight to the next STEP.

Checkmate Synology NAS Set up 13

  • STEP 21

On the left sidebar, click Status pages. Click Create a status page. Follow the instructions in the image below.

Checkmate Synology NAS Set up 14

  • STEP 22

Add your website details, then select the monitor that you want to display in the status page. Upload your logo then click Save. Follow the instructions in the image below.

Checkmate Synology NAS Set up 15

  • STEP 23

Copy the public link then open in a new page. Follow the instructions in the image below.

Checkmate Synology NAS Set up 16

  • STEP 24

Your public status page at a glance!

Checkmate Synology NAS Set up 17

Enjoy Checkmate!

šŸ†˜TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article. āš ļøNote: This guide works only on a Synology NAS that supports AVX.

Note: Can I run Docker on my Synology NAS?Ā See the supported models.
Note: How to Back Up Docker Containers on your Synology NAS.
Note: Find outĀ how to update the Checkmate container with the latest image.
Note: How to Free Disk Space on Your NAS if You Run Docker.
Note: How to Schedule Start & Stop For Docker Containers.
Note: How to Activate Email Notifications.
Note: How to Add Access Control Profile on Your NAS.
Note: How to Change Docker Containers Restart Policy.
Note: How to Use Docker Containers With VPN.
Note: Convert Docker Run Into Docker Compose.
Note: How to Clean Docker.
Note: How to Clean Docker Automatically.
Note: Best Practices When Using Docker and DDNS.
Note: Some Docker Containers Need WebSocket.
Note: Find out the Best NAS Models For Docker.
Note: Activate Gmail SMTP For Docker Containers.

This post was updated on Monday / May 11th, 2026 at 1:45 AM

No sponsors, no corporations, no ads, no subscriptions, no membership tiers, no referral links, no pop-ups, no cookies, no tracking code. Just pure guides for the community from Marius.