Hexy Templates

Unifi Controller

Unifi Controller is a network management controller for Unifi Equipment.

Not yet tested networking Based on TrueNAS app v2.1.15 (Unifi Controller 10.6.106)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Unifi Controller and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
unifi-controller.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS unifi-controller 2.1.15"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30072, 30073, 30074, 30075]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/unifi-controller"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/unifi-controller/data",
18      "snapshot": {"id": "data"}
19    }
20  ],
21  "app_values": {
22    "storage": {
823      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/unifi-controller/data)"
24    },
25    "network": {
926      "web_https_port": {"bind_mode": "published", "port_number": 30072},
1027      "web_http_port": {"bind_mode": "published", "port_number": 30073},
1128      "portal_https_port": {
29        "bind_mode": "published",
30        "port_number": 30074
31      },
1232      "portal_http_port": {
33        "bind_mode": "published",
34        "port_number": 30075
35      }
36    },
1337    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
38  }
39}

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 unifi-controller 2.1.15”.

    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 30072, 30073, 30074 and 30075 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) › unifi-controller and App storage (fast) › unifi-controller › data. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–20

  8. Where the app's main data is saved

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

    Line 23

  9. Web https port: 30072

    Publishes the app's web https port as 30072.

    Line 26

  10. Web http port: 30073

    Publishes the app's web http port as 30073.

    Line 27

  11. Portal https port: 30074

    Publishes the app's portal https port as 30074.

    Lines 28–31

  12. Portal http port: 30075

    Publishes the app's portal http port as 30075.

    Lines 32–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 37