Skip to content

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 docker-compose.yml 
    version: "3"
services:
  front:
    image: tombursch/kitchenowl-web:latest
    restart: unless-stopped
    # environment:
    #   - BACK_URL=back:5000 # Change this if you rename the containers
    ports:
      - "80:80"
    depends_on:
      - back
  back:
    image: tombursch/kitchenowl-backend: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 want to use PostgreSQL, change the container names, or want to set other settings take a look at the advanced options
  4. Run docker compose up -d
  1. Create a volume docker volume create kitchenowl_data
  2. Run docker exec -d -p 8080:8080 -e "JWT_SECRET_KEY=PLEASE_CHANGE_ME" -v kitchenowl_data:/data tombursch/kitchenowl:latest
  1. Download docker-compose.yml 
    version: "3"
services:
  back:
    image: tombursch/kitchenowl:latest
    restart: unless-stopped
    ports:
      - "80:8080"
    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 want to use PostgreSQL, use separate containers for front and backend, 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:

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: