Hexy Templates

Open WebUI

Open WebUI is an extensible, feature-rich, and user-friendly self-hosted WebUI designed to operate entirely offline. It supports various LLM runners, including Ollama and OpenAI-compatible APIs.

Not yet tested ai Based on TrueNAS app v1.3.28 (Open WebUI v0.11.4)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Open WebUI and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
open-webui.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS open-webui 1.3.28"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [31028]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/open-webui"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/open-webui/data",
18      "snapshot": {"id": "data"}
19    },
20    {
21      "path": "$LOCATION(ApplicationsPerformance)/open-webui/ollama",
22      "snapshot": {"id": "ollama"}
23    }
24  ],
25  "app_values": {
26    "open_webui": {
827      "redis_password": "$RANDOM_STRING(16)",
928      "webui_secret_key": "$RANDOM_STRING(32)"
29    },
30    "storage": {
1031      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/open-webui/data)",
1132      "ollama": "$HOST_PATH($LOCATION(ApplicationsPerformance)/open-webui/ollama)"
33    },
34    "network": {
1235      "web_port": {"bind_mode": "published", "port_number": 31028}
36    },
37    "resources": {
1338      "limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"},
1439      "gpus": "$GPU_CONFIG()"
40    }
41  }
42}

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 open-webui 1.3.28”.

    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 31028 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) › open-webui, App storage (fast) › open-webui › data and App storage (fast) › open-webui › ollama. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–24

  8. Auto-generated redis password

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

    Line 27

  9. Auto-generated webui secret key

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

    Line 28

  10. Where the app's main data is saved

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

    Line 31

  11. Where the app's “ollama” files is saved

    Where the app's “ollama” files is saved on your server: App storage (fast) › open-webui › ollama.

    Line 32

  12. Web port: 31028

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

    Line 35

  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 38

  14. Graphics card access

    If your server has a supported graphics card, HexOS shares it with the app (useful for video conversion or AI features).

    Line 39