Hexy Templates

Authentik

The authentication glue you need.

Not yet tested authentication Based on TrueNAS app v1.3.47 (Authentik 2026.8.3)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Authentik and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
authentik.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS authentik 1.3.47"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30140, 30141]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/authentik"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/authentik/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/authentik/templates",
23      "owner": {"user": "apps"},
24      "snapshot": {"id": "templates"}
25    },
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/authentik/certs",
28      "owner": {"user": "apps"},
29      "snapshot": {"id": "certs"}
30    },
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/authentik/postgres_data",
33      "owner": {"user": "netdata", "group": "docker"},
34      "snapshot": {"id": "postgres_data"}
35    }
36  ],
37  "app_values": {
38    "authentik": {
839      "db_password": "$RANDOM_STRING(16)",
940      "secret_key": "$RANDOM_STRING(32)"
41    },
42    "storage": {
1043      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/authentik/data)",
1144      "templates": "$HOST_PATH($LOCATION(ApplicationsPerformance)/authentik/templates)",
1245      "certs": "$HOST_PATH($LOCATION(ApplicationsPerformance)/authentik/certs)",
1346      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/authentik/postgres_data)"
47    },
48    "network": {
1449      "http_port": {"bind_mode": "published", "port_number": 30140},
1550      "https_port": {"bind_mode": "published", "port_number": 30141}
51    },
1652    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
53  }
54}

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 authentik 1.3.47”.

    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 ports 30140 and 30141 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) › authentik, App storage (fast) › authentik › data, App storage (fast) › authentik › templates, App storage (fast) › authentik › certs and App storage (fast) › authentik › 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–36

  8. Auto-generated db password

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

    Line 39

  9. Auto-generated secret key

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

    Line 40

  10. Where the app's main data is saved

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

    Line 43

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

    Where the app's “templates” files is saved on your server: App storage (fast) › authentik › templates.

    Line 44

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

    Where the app's “certs” files is saved on your server: App storage (fast) › authentik › certs.

    Line 45

  13. Where the app's database is saved

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

    Line 46

  14. Http port: 30140

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

    Line 49

  15. Https port: 30141

    Publishes the app's https port as 30141.

    Line 50

  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 52