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 spend. In this step by step guide I will show you how to install KitchenOwl on your Synology NAS using Docker.

Note: This guide works perfectly with the latest KitchenOwl v.0.3.6 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

Destination:
Protocol: HTTP
Hostname: localhost
Port: 7180

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

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.

version: "3"
services:
    front:
        image: tombursch/kitchenowl-web:latest
        environment:
        - FRONT_URL=https://kitchenowl.mariushosting.synology.me
        ports:
        - 7180:80
        depends_on:
        - back
        networks:
        - default
    back:
        image: tombursch/kitchenowl:latest
        restart: always
        networks:
        - default
        environment:
        - JWT_SECRET_KEY=MariushostingMariushostingMari13
        - FRONT_URL=https://kitchenowl.mariushosting.synology.me
        volumes:
        - /volume1/docker/kitchenowl:/data

volumes:
    kitchenowl_data:

networks:
    default:

Note: Before you paste the code above in the Web editor area, change the value for FRONT_URL and add your own synology.me wildcard that you have set up at STEP 6. In the code above don’t forget to add https:// before kitchenowl.yourname.synology.me
Note: Before you paste the code above in the Run command area below, change the value for JWT_SECRET_KEY and add your own JWT SECRET KEY. MariushostingMariushostingMari13 is an example for a JWT SECRET KEY. You should invent your own Value. Add 32 random characters, both letters and numbers.
Note: Before you paste the code above in the Web editor area, change the value for FRONT_URL and add your own synology.me wildcard that you have set up at STEP 6. In the code above don’t forget to add https:// before kitchenowl.yourname.synology.me

KitchenOwl Synology NAS Set up 8

  • 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

  • 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

  • STEP 15

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

  • STEP 16

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 credentials then click Next. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 11

  • STEP 17

Choose Meal Planner and Balances. Select your Language then click Start. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 12

  • STEP 18

On the left Sidebar click on Profile, then change the theme to Dark Mode. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 13

  • STEP 19

On the left Sidebar click on Recipe. At the bottom right of the page you can click 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 14 new

  • STEP 20

Click Next. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 15

  • STEP 21

Click Add Recipe. Follow the instructions in the image below.

KitchenOwl Synology NAS Set up 16

Start adding multiple recipes!

KitchenOwl Synology NAS Set up 17

  • STEP 22

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

Note: Can I run Docker on my Synology NAS? See the supported models.
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.

This post was updated on Thursday / November 17th, 2022 at 3:05 PM