Hexy Templates

Windmill

Open-source developer platform and workflow engine

Not yet tested productivity Based on TrueNAS app v1.2.158 (Windmill 1.822.0)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Windmill and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
windmill.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS windmill 1.2.158"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "ApplicationsCapacity"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30155, 30156]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/windmill"},
16    {"path": "$LOCATION(ApplicationsCapacity)"},
17    {"path": "$LOCATION(ApplicationsCapacity)/windmill"},
18    {
19      "path": "$LOCATION(ApplicationsPerformance)/windmill/postgres_data",
20      "owner": {"user": "netdata", "group": "docker"},
21      "snapshot": {"id": "postgres_data"}
22    },
23    {"path": "$LOCATION(ApplicationsCapacity)/windmill/worker_cache"},
24    {"path": "$LOCATION(ApplicationsCapacity)/windmill/worker_logs"},
25    {"path": "$LOCATION(ApplicationsCapacity)/windmill/lsp_cache"},
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/windmill/caddy_data",
28      "snapshot": {"id": "caddy_data"}
29    }
30  ],
31  "app_values": {
832    "windmill": {"db_password": "$RANDOM_STRING(16)"},
33    "storage": {
934      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/windmill/postgres_data)",
1035      "worker_cache": "$HOST_PATH($LOCATION(ApplicationsCapacity)/windmill/worker_cache)",
1136      "worker_logs": "$HOST_PATH($LOCATION(ApplicationsCapacity)/windmill/worker_logs)",
1237      "lsp_cache": "$HOST_PATH($LOCATION(ApplicationsCapacity)/windmill/lsp_cache)",
1338      "caddy_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/windmill/caddy_data)"
39    },
40    "network": {
1441      "web_port": {"bind_mode": "published", "port_number": 30155},
1542      "smtp_port": {"bind_mode": "published", "port_number": 30156}
43    },
1644    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
45  }
46}

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 windmill 1.2.158”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast) and App storage (large). 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 ports 30155 and 30156 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) › windmill, App storage (large) › windmill, App storage (fast) › windmill › postgres_data, App storage (large) › windmill › worker_cache, App storage (large) › windmill › worker_logs, App storage (large) › windmill › lsp_cache and App storage (fast) › windmill › caddy_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–30

  8. Auto-generated db password

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

    Line 32

  9. Where the app's database is saved

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

    Line 34

  10. Where the app's “worker cache” files is saved

    Where the app's “worker cache” files is saved on your server: App storage (large) › windmill › worker_cache.

    Line 35

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

    Where the app's “worker logs” files is saved on your server: App storage (large) › windmill › worker_logs.

    Line 36

  12. Where the app's “lsp cache” files is saved

    Where the app's “lsp cache” files is saved on your server: App storage (large) › windmill › lsp_cache.

    Line 37

  13. Where the app's “caddy data” files is saved

    Where the app's “caddy data” files is saved on your server: App storage (fast) › windmill › caddy_data.

    Line 38

  14. Web port: 30155

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

    Line 41

  15. Smtp port: 30156

    Publishes the app's smtp port as 30156.

    Line 42

  16. 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 44