Portainer Templates logo

Portainer Templates

KitchenOwl KitchenOwl

Stack

ProductivityFinance

Grocery list and recipe manager for households, with shopping lists that sync live between everyone, recipes you can add to the list in one go, a meal planner and shared expenses. Source: https://github.com/TomBursch/kitchenowl

Image details

Pulls: 1.8M
Architecture: amd64, arm64
Image size: 286 MB
Latest: v0.7.10
User: tombursch
Created: Mar 10, 2021
Updated: 21 days ago
Status: active

Source details

Repo: TomBursch/kitchenowl
Stars: 4k
Forks: 252
Language: Dart
License: AGPL-3.0
Latest: v0.7.10 · 2 months ago
Updated: 21 days ago
Website: kitchenowl.org/

Configuration

Type
Compose
Platform
linux
Image
tombursch/kitchenowl:latest
Ports
${KITCHENOWL_PORT:-8070}:8080
Volumes
/data : kitchenowl-data
Env vars
JWT_SECRET_KEY=${KITCHENOWL_SECRET:?Set a secret key}KITCHENOWL_SECRET=''KITCHENOWL_PORT=8070
Restart
unless-stopped
Source
Repo

Template by NotAFlightRisk·Source

Report issue

Notes

Set the secret key before you deploy (openssl rand -hex 32 makes a good one), since the stack won't start without it. Then open http://<your-host>:8070 (or whichever port you picked) and the first page creates the admin account. There's no setup code, so do it straight after deploying. Sign-ups are off, so the admin adds everyone else under Settings --> Users, then adds them to a household's members. The SQLite database and uploaded photos live in the kitchenowl-data volume. Docs: docs.kitchenowl.org

Standalone Install

Select an install method, to see config/commands for deploying KitchenOwl

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select KitchenOwl, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  kitchenowl:
    image: tombursch/kitchenowl:latest
    restart: unless-stopped
    ports:
      - "${KITCHENOWL_PORT:-8070}:8080"
    environment:
      JWT_SECRET_KEY: ${KITCHENOWL_SECRET:?Set a secret key}
    volumes:
      - kitchenowl-data:/data

volumes:
  kitchenowl-data:

Or deploy it directly from the source:

git clone https://github.com/NotAFlightRisk/portainer-templates-extras
cd portainer-templates-extras
docker compose -f apps/kitchenowl/compose.yml up -d

More install options in our documentation, or see TomBursch/kitchenowl for app-specific guidance.

KitchenOwl

Find all related information about setup and what this does on the website

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Image won't pull

Test the pull directly on the host: docker pull tombursch/kitchenowl:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

KITCHENOWL_SECRET has no default value, and kitchenowl may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

KitchenOwl is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything KitchenOwl needs bundled into one download. This template pulls tombursch/kitchenowl:latest, which Docker fetches once (about 286 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. KitchenOwl's comes from Docker Hub, published by tombursch.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Newest right now is v0.7.10. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Volumes

A volume is where KitchenOwl keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data kept in the kitchenowl-data volume Docker manages

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. KitchenOwl takes 3 of them, and 2 need a value before it'll start properly:

  • JWT_SECRET_KEY, needs a value
  • KITCHENOWL_SECRET, needs a value. Signs everyone's logins. Generate one with: openssl rand -hex 32. Keep it the same when you redeploy, or everyone gets logged out.
  • KITCHENOWL_PORT, defaults to 8070. Host port for the web UI

Restart policy

The restart policy here is unless-stopped, so Docker restarts KitchenOwl after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Nothing custom is set, so KitchenOwl sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container kitchenowl. That's what you'll spot in the containers list and use in commands like docker logs kitchenowl.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Open source license

KitchenOwl is open source, released under the AGPL-3.0 license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set KitchenOwl up. Add the template list to Portainer once, then deploying KitchenOwl is a click rather than a wall of config.