How to Install Kimai on Your Synology NAS

How to Install Kimai on Your Synology NAS

Kimai is a free, open source and online time-tracking software designed for small businesses and freelancers. It is built with modern technologies such as Symfony, Bootstrap, RESTful API, Doctrine, AdminLTE, Webpack, ES6 and many more. In this step by step guide I will show you how to install Kimai on your Synology NAS using Docker and Portainer.

Note: This guide works perfectly with the latest Kimai v1.30.5 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.

Kimai Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

Destination:
Protocol: HTTP
Hostname: localhost
Port: 9805

Kimai 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.

Kimai 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.

Kimai 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 kimai. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Kimai Synology NAS Set up 6

  • STEP 11

Now create three new folders inside the kimai folder that you created at STEP 10 and name them db, public, var. Follow the instructions in the image below.
Note: Be careful to enter only lowercase, not uppercase letters.

Kimai Synology NAS Set up 7

  • STEP 12

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 13

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

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

version: "3.9"
services:
  db:
    image: mariadb:jammy
    container_name: Kimai-DB
    hostname: kimai-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD-SHELL", "mysqladmin ping -P 3306 -prootpass | grep 'mysqld is alive' || exit 1"]
      start_period: 30s
    environment:
      - TZ=Europe/Bucharest
      - MYSQL_ROOT_PASSWORD=rootpass
      - MYSQL_DATABASE=kimai
      - MYSQL_USER=kimaiuser
      - MYSQL_PASSWORD=kimaipass
    volumes:
      - /volume1/docker/kimai/db:/var/lib/mysql:rw
    restart: always

  kimai:
    image: kimai/kimai2:latest
    container_name: Kimai
    hostname: kimai
    security_opt:
      - no-new-privileges:true
    user: 1026:100
    healthcheck:
      test: stat /etc/passwd || exit 1
      start_period: 45s
    volumes:
      - /volume1/docker/kimai/var:/opt/kimai/var
      - /volume1/docker/kimai/public:/opt/kimai/public
    environment:
      - DATABASE_URL=mysql://kimaiuser:kimaipass@kimai-db/kimai
      - TRUSTED_HOSTS=192.168.1.18,kimai.yourname.synology.me
    restart: always
    depends_on:
      db:
        condition: service_started

  nginx:
    image: tobybatch/nginx-fpm-reverse-proxy
    container_name: Kimai-NGINX
    hostname: kimai-nginx
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: wget --spider http://nginx/health || exit 1
      interval: 20s
      start_period: 10s
      timeout: 10s
      retries: 3
    ports:
      - 9805:80
    volumes:
      - /volume1/docker/kimai/public:/opt/kimai/public:ro
    restart: always
    depends_on:
      kimai:
        condition: service_healthy

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 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.
Note: Before you paste the code above in the Web editor area below, change the value for TRUSTED_HOSTS and type in your own local NAS IP and your own synology.me DDNS without https:// at the beginning that you have previously created at STEP 6. The local NAS IP and DDNS are separated by a comma.

Kimai Synology NAS Set up 8 new2 2023

  • STEP 14

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.

Kimai Synology NAS Set up 9 new2 2023

  • STEP 15

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

Kimai Synology NAS Set up 10

  • STEP 16

On the left sidebar in Portainer, click Containers. Identify your Kimai instance, then click on the little terminal icon. Follow the instructions in the image below.

Kimai Synology NAS Set up 11

  • STEP 17

After you click on the little terminal icon at STEP 16, a new page will open. Click Connect. Follow the instructions in the image below.

Kimai Synology NAS Set up 12

  • STEP 18

After you click Connect at STEP 17, a Console will open. Copy Paste the code below and follow the instructions in the image.

/opt/kimai/bin/console kimai:create-user marius yourownemail ROLE_SUPER_ADMIN

Note: Before you paste the code above in the Console area below, change marius with your own Username.
Note: Before you paste the code above in the Console area below, change yourownemail text with your email.

Kimai Synology NAS Set up 13

  • STEP 19

Once the code is inserted, confirm by pressing Enter on your keyboard. You will be prompted to add your own Password. Confirm Password by pressing enter on your keyboard.

Kimai Synology NAS Set up 14

  • STEP 20

You will get a green message that says Success!

Kimai Synology NAS Set up 15

  • STEP 21

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

  • STEP 22

Now open your browser and type in your HTTPS/SSL certificate like this https://kimai.yourname.synology.me that you have previously created at STEP 6. In my case it’s https://kimai.mariushosting.synology.me If everything goes right, you will see the main Kimai login page. Type in your own Username and Password that you have previously created at STEP 18 and STEP 19 respectively. Click Login. Follow the instructions in the image below.

Kimai Synology NAS Set up 16

Welcome to your Kimai – Time Tracking Dashboard!

Kimai Synology NAS Set up 17

Enjoy Kimai!

Note: Find out how to update the Kimai container with the latest image.
Note: Can I run Docker on my Synology NAS? See the supported models.
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 Sunday / January 29th, 2023 at 5:22 AM