Getting Started

There are multiple ways you can install the KitchenOwl server.

Official Installation

The official installation method is using Docker and docker-compose:

1. Download the docker-compose.yml

   version: "3"
   services:
     front:
       image: tombursch/kitchenowl-web:latest
       restart: unless-stopped
       ports:
         - "80:80"
       depends_on:
         - back
     back:
       image: tombursch/kitchenowl:latest
       restart: unless-stopped
       environment:
         - JWT_SECRET_KEY=PLEASE_CHANGE_ME
       volumes:
         - kitchenowl_data:/data
   
   volumes:
     kitchenowl_data:
   

2. Change the default value for JWT_SECRET_KEY
3. If you change the container names, want to use PostgreSQL, or want to set other settings take a look at the advanced options
4. Run docker compose up -d

Important

We recommend running KitchenOwl behind a reverse proxy with HTTPS (e.g. nginx or Traefik). Some example configurations have been contributed.

It is also important that you have HTTP Strict Transport Security enabled and the proper headers applied to your responses or you could be subject to a javascript hijack.

Please see:

• https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security
• https://www.netsparker.com/blog/web-security/http-security-headers/

Updating KitchenOwl

To upgrade a docker compose stack, you can simply run:

docker compose pull
docker compose up -d

Community Installation Methods

Here is a list of community maintained install methods:

• Unraid (Source AGPL-3.0)
• Cosmos (Source AGPL-3.0)
• TrueNAS SCALE (Source BSD-3-Clause)