How to Install KitchenOwl on Your Synology NAS

How to Install KitchenOwl on Your Synology NAS

KitchenOwl is a smart, self-hosted grocery list and recipe manager. Easily add items to your shopping list before you go shopping. You can also create recipes and get suggestions on what you want to cook. Track your expenses so you know how much you’ve spent. In this step by step guide I will show you how to install KitchenOwlĀ on yourĀ Synology NAS using Docker & Portainer.

šŸ’”Note: This guide works perfectly with the latest KitchenOwl v0.6.8Ā 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.

KitchenOwl Synology NAS Set up 1

  • STEP 5

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

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

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

Check Enable HSTS

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

KitchenOwl Synology NAS Set up 3 new

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

KitchenOwl Synology NAS Set up 5

  • STEP 9

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

KitchenOwl Synology NAS Set up 6

  • STEP 10

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

KitchenOwl Synology NAS Set up 7

  • STEP 11

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 12

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

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

services:
  front:
    image: tombursch/kitchenowl-web:latest
    container_name: KitchenOwl-FRONT
    healthcheck:
      test: ["CMD-SHELL", "nc -z 127.0.0.1 80 || exit 1"]
      interval: 10s
      timeout: 5s
      retries: 3
      start_period: 90s
    environment:
      FRONT_URL: https://kitchenowl.yourname.synology.me
    ports:
     - 7180:80
    depends_on:
        - back
    restart: on-failure:5
        
  back:
    image: tombursch/kitchenowl:latest
    container_name: KitchenOwl-BACK
    restart: on-failure:5
    environment:
      JWT_SECRET_KEY: aHZVKFITcKXLcOsdsJiDLPFEwsXvMseE
      FRONT_URL: https://kitchenowl.yourname.synology.me
    volumes:
     - /volume1/docker/kitchenowl:/data:rw

Note: Before you paste the code above in the Web editor area below, change the value for FRONT_URLĀ 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 JWT_SECRET_KEY.Ā (Generate your own 32 length JWT_SECRET_KEY.)

KitchenOwl Synology NAS Set up 8 new 2025

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

KitchenOwl Synology NAS Set up 9 new 2025

  • STEP 14

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

KitchenOwl Synology NAS Set up 10 new 2025

  • 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

Please wait approximately 3 minutes or you will get a blank error page if you try to connect too soon. Now open your browser and type in your HTTPS/SSL certificate like this https://kitchenowl.yourname.synology.me In my case it’s https://kitchenowl.mariushosting.synology.me If everything goes right, you will see the KitchenOwl page. Add your own Username and Password, then click Start. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 11 new 2025

  • STEP 17

Click Skip. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 12 new 2025

  • STEP 18

On the left Sidebar, click on the Profile icon. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 13 new 2025

  • STEP 19

Change the theme to Dark. Click the left arrow to go back to the first page. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 14 new 2025

  • STEP 20

Add a new household by clicking the plus button at the bottom right of the page. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 15 new 2025

  • STEP 21

Upload your own logo/banner, give a name to the household, then click Add. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 16 new 2025

  • STEP 22

On the left Sidebar, click on Recipes. At the bottom right of the page, you can click on the Link button and paste the recipeĀ to import recipes from the world wide web. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 17 new 2025

  • STEP 23

Type in the recipe URL. Click Add. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 18 new 2025

  • STEP 24

Click Next to add the recipe to your list. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 19 new 2025

  • STEP 25

You can also install the KitchenOwl App on your Android Phone and then open it. In the Address area, type in your own synology.me wildcard certificate that you have previously created at STEP 6. Log in using your own credentials that you have previously created at STEP 16. Enjoy your selfhosted KitchenOwl app!

KitchenOwl Synology NAS Set up 18

Enjoy KitchenOwl!

šŸ†˜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: How to Back Up Docker Containers on your Synology NAS.
Note: Find outĀ how to update the KitchenOwl 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 Saturday / January 18th, 2025 at 12:41 AM