Hexy Templates

KitchenOwl

KitchenOwl is a self-hosted grocery list and recipe manager. The backend is made with Flask and the frontend with Flutter. Easily add items to your shopping list before you go shopping. You can also create recipes and add items based on what you want to cook.

Not yet tested productivity Based on TrueNAS app v1.2.35 (KitchenOwl v0.7.10)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find KitchenOwl and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
kitchenowl.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS kitchenowl 1.2.35"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30211]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/kitchenowl"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/kitchenowl/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/kitchenowl/postgres_data",
23      "owner": {"user": "netdata", "group": "docker"},
24      "snapshot": {"id": "postgres_data"}
25    }
26  ],
27  "app_values": {
28    "kitchenowl": {
829      "db_password": "$RANDOM_STRING(16)",
930      "jwt_secret_key": "$RANDOM_STRING(32)"
31    },
32    "storage": {
1033      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/kitchenowl/data)",
1134      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/kitchenowl/postgres_data)"
35    },
36    "network": {
1237      "web_port": {"bind_mode": "published", "port_number": 30211}
38    },
1339    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
40  }
41}

What this script does

Hover or tap a box to see the lines it explains.

  1. Script format

    Tells HexOS this is a version 5 install script, so it knows how to read the rest.

    Line 2

  2. Script revision

    This copy of the script is revision 0.1.0. Latest change: “Auto-generated draft from TrueNAS kitchenowl 1.2.35”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast). If one isn't set up yet, HexOS will ask you to pick a place for it.

    Line 8

  4. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 9

  5. Permission to use your folders

    Allows the app to read and write files inside the storage locations listed above — and nowhere else.

    Line 10

  6. Network ports

    The app needs port 30211 to be free on your server. A port is like an apartment number for your server's address.

    Line 11

  7. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › kitchenowl, App storage (fast) › kitchenowl › data and App storage (fast) › kitchenowl › postgres_data. Some folders are handed to a specific system user so the app is allowed to write to them. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–26

  8. Auto-generated db password

    HexOS makes up a long random db password during install. It's only used inside KitchenOwl, so you never need to know it.

    Line 29

  9. Auto-generated jwt secret key

    HexOS makes up a long random jwt secret key during install. It's only used inside KitchenOwl, so you never need to know it.

    Line 30

  10. Where the app's main data is saved

    Where the app's main data is saved on your server: App storage (fast) › kitchenowl › data.

    Line 33

  11. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › kitchenowl › postgres_data.

    Line 34

  12. Web port: 30211

    The app's web page is published on port 30211. You don't need to remember it — clicking the app's card in HexOS takes you there.

    Line 37

  13. Resource limits

    Caps how much of your server the app can use: 2 CPU cores and 10% of your server's memory, but never more than 4 GB. This keeps one busy app from slowing everything else down.

    Line 39