# Self-host KitchenOwl

> A shared grocery list, recipe and expense app for your household, with web and mobile clients.

- Page: https://levelrail.com/templates/kitchenowl/
- JSON: https://levelrail.com/templates/kitchenowl.json
- Category: Productivity
- Licence: AGPL-3.0-only (Network copyleft (AGPL) license)
- Source: https://github.com/TomBursch/kitchenowl
- Upstream docs: https://docs.kitchenowl.org/

## Requirements
- Memory: about 256 MiB
- amd64: unknown, arm64: unknown
- Needs configuration before start: no
- Pinned image tag: v0.8.1

## Services

| Service | Image | Tag | Ports | Volumes |
| --- | --- | --- | --- | --- |
| kitchenowl | tombursch/kitchenowl | v0.8.1 | 8080 | data -> /data |

## Environment

| Service | Variable | Kind |
| --- | --- | --- |
| kitchenowl | JWT_SECRET_KEY | generated |

## Deploy

### CLI

```bash
levelrail-cli templates install kitchenowl --name my-kitchenowl
```

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain kitchenowl=app.example.com.

### API

```bash
curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/kitchenowl/install \
  -d '{
    "name": "my-kitchenowl"
  }'
```

Create a token in the dashboard first. Name, env and domains are the request fields.

## First run
1. Create the first account on the web page, it becomes the admin.

## Questions

### Can I deploy KitchenOwl on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list has an entry with the id kitchenowl for this app, so check that entry as well. Dokku deploys container images with its own commands, so the pinned image tombursch/kitchenowl:v0.8.1 is what you deploy there.

Self-host KitchenOwl, KitchenOwl docker compose file, deploy KitchenOwl on a VPS: this page lists the pinned image, ports, volumes and the commands for each.
