Hexy Templates

LLDAP

Lightweight LDAP server with built-in web interface for identity management.

Not yet tested authentication Based on TrueNAS app v1.1.8 (LLDAP v0.6.3-alpine-rootless)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find LLDAP and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
lldap.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS lldap 1.1.8"
6  },
37  "installation_questions": [
8    {
9      "question": "Admin username",
10      "type": "text",
11      "key": "admin_username",
12      "required": true
13    },
14    {
15      "question": "Admin email",
16      "type": "text",
17      "key": "admin_email",
18      "required": true
19    },
20    {
21      "question": "Admin password",
22      "type": "password",
23      "key": "admin_password",
24      "required": true
25    },
26    {
27      "question": "Key seed",
28      "type": "password",
29      "key": "key_seed",
30      "required": true
31    }
32  ],
33  "requirements": {
434    "locations": ["ApplicationsPerformance"],
535    "specifications": ["2CORE"],
636    "permissions": ["READ_WRITE_LOCATIONS"],
737    "ports": [30325, 30326]
38  },
839  "ensure_directories_exists": [
40    {"path": "$LOCATION(ApplicationsPerformance)"},
41    {"path": "$LOCATION(ApplicationsPerformance)/lldap"},
42    {
43      "path": "$LOCATION(ApplicationsPerformance)/lldap/data",
44      "owner": {"user": "apps"},
45      "snapshot": {"id": "data"}
46    }
47  ],
48  "app_values": {
49    "lldap": {
950      "admin_username": "$QUESTION(admin_username)",
1051      "admin_email": "$QUESTION(admin_email)",
1152      "admin_password": "$QUESTION(admin_password)",
1253      "jwt_secret": "$RANDOM_STRING(32)",
1354      "key_seed": "$QUESTION(key_seed)"
55    },
56    "storage": {
1457      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/lldap/data)"
58    },
59    "network": {
1560      "http_port": {"bind_mode": "published", "port_number": 30325},
1661      "ldap_port": {"bind_mode": "published", "port_number": 30326}
62    },
1763    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
64  }
65}

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 lldap 1.1.8”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Admin username, Admin email, Admin password and Key seed. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–32

  4. 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 34

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 35

  6. Permission to use your folders

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

    Line 36

  7. Network ports

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

    Line 37

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › lldap and App storage (fast) › lldap › 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 39–47

  9. Your answer: admin username

    Filled in with what you typed for “admin username” when you installed.

    Line 50

  10. Your answer: admin email

    Filled in with what you typed for “admin email” when you installed.

    Line 51

  11. Your answer: admin password

    Filled in with what you typed for “admin password” when you installed.

    Line 52

  12. Auto-generated jwt secret

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

    Line 53

  13. Your answer: key seed

    Filled in with what you typed for “key seed” when you installed.

    Line 54

  14. Where the app's main data is saved

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

    Line 57

  15. Http port: 30325

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

    Line 60

  16. Ldap port: 30326

    Publishes the app's ldap port as 30326.

    Line 61

  17. 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 63