How to Install Kener on Your Synology NAS

How to Install Kener on Your Synology NAS

Kener is an open-source Node.js status page tool, designed to make service monitoring and incident handling a breeze. It offers a sleek and user-friendly interface that simplifies tracking service outages and improves how we communicate during incidents. In this step by step guide I will show you how to install Kener on your Synology NAS using Docker & Portainer.

💡Note: This guide works perfectly with the latest Kener v0.0.7 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

Install Text Editor via Synology “Package Center”. (Mandatory STEP.) If you already have Text Editor installed on your Synology NAS, skip this STEP.

Synology Install Text Editor 2023

  • STEP 5

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

Kener Synology NAS Set up 1

  • STEP 6

Now click the “Create” button. Follow the instructions in the image below.

Kener Synology NAS Set up 2

  • STEP 7

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 Kener. After that, add the following instructions:

Source:
Protocol: HTTPS
Hostname: kener.yourname.synology.me
Port: 443

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 3161

Kener Synology NAS Set up 3

  • STEP 8

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 9

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

Kener Synology NAS Set up 4

  • STEP 10

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

Kener Synology NAS Set up 5

  • STEP 11

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

Kener Synology NAS Set up 6

  • STEP 13

Log into Portainer using your username and password. On the left sidebar in Portainer, click on Stacks then + Add stack. Follow the instructions in the image below.

1 Synology Portainer Add Stack

  • STEP 14

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

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

version: '3.9'
services:
 kener:
    image: rajnandan1/kener:latest
    container_name: Kener
    healthcheck:
     test: curl -f http://localhost:3000/ || exit 1
    security_opt:
      - no-new-privileges:true
    environment:
      TZ: Europe/Bucharest
      PUID: 1026
      PGID: 100
      # GH_TOKEN: 
      # API_TOKEN: 
      # API_IP: 
    ports:
      - 3161:3000/tcp
    volumes:
      - /volume1/docker/kener:/config:rw

Note: Before you paste the code above in the Web editor area below, change the value for TZ. (Select your current Time Zone from this list.)
Note: Before you paste the code above in the Web editor area below, change the value numbers for PUID and PGID with your own values. (Follow my step by step guide on how to do this.)

Kener Synology NAS Set up 7

  • STEP 15

Scroll down on the page until you see a button called 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.

Kener Synology NAS Set up 8

  • STEP 16

If everything goes right, you will see this message at the top right of your screen: “Success Stack successfully deployed“.

Kener Synology NAS Set up 9

  • STEP 17

Go back to STEP 1 or you will deal with karma 🙂.

  • STEP 18

The installation process can take up to a few seconds/minutes. Now open your browser and type in your HTTPS/SSL certificate like this https://kener.yourname.synology.me In my case it’s https://kener.mariushosting.synology.me If everything goes right, you will see the Kener main page. Follow the instructions in the image below.

Kener Synology NAS Set up 10

  • STEP 19

Let’s start modifying the frontend website monitoring page. Open the kener folder that you have previously created at STEP 11, then click monitors.yaml to modify the websites that you want to monitor. After you make your changes, click x to save the file. Follow the instructions in the image below.

Kener Synology NAS Set up 11

  • STEP 20

Let’s start modifying the frontend website page. Open the kener folder that you have previously created at STEP 11, then click site.yaml to modify the frontend page. After you make your changes, click x to save the file. Follow the instructions in the image below.

Kener Synology NAS Set up 12

  • STEP 21

Open Portainer. On the left sidebar click Containers. Select your Kener instance, then click Restart. Follow the instructions in the image below.

Kener Synology NAS Set up 13

  • STEP 22

Now open your browser and type in your HTTPS/SSL certificate like this https://kener.yourname.synology.me In my case it’s https://kener.mariushosting.synology.me If everything goes right, you will see the Kener main page with the changes you’ve made at STEP 19 and STEP 20 respectively. You can Fully Brand your status page! Follow the instructions in the image below.

Kener Synology NAS Set up 14

  • STEP 23

If you click on the little share icon under your website name, you also have access to different share options. Follow the instructions in the image below.

Kener Synology NAS Set up 15

Enjoy Kener!

🆘TROUBLESHOOTING

If you encounter issues by using this container, make sure to check out the Common Docker issues article.

Note: Can I run Docker on my Synology NAS? See the supported models.
Note: Find out how to update the Kener 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 Wednesday / January 31st, 2024 at 11:53 PM