Hexy Templates

Eclipse Mosquitto

Eclipse Mosquitto is an open source MQTT broker

Not yet tested networking Based on TrueNAS app v1.2.8 (Eclipse Mosquitto 2.0.22)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Eclipse Mosquitto and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
eclipse-mosquitto.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS eclipse-mosquitto 1.2.8"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [1883, 8081]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/eclipse-mosquitto"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/eclipse-mosquitto/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    },
21    {
22      "path": "$LOCATION(ApplicationsPerformance)/eclipse-mosquitto/config",
23      "owner": {"user": "apps"},
24      "snapshot": {"id": "config"}
25    }
26  ],
27  "app_values": {
28    "storage": {
829      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/eclipse-mosquitto/data)",
930      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/eclipse-mosquitto/config)"
31    },
32    "network": {
1033      "broker_port": {"bind_mode": "published", "port_number": 1883},
1134      "ws_port": {"bind_mode": "published", "port_number": 8081}
35    },
1236    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
37  }
38}

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 eclipse-mosquitto 1.2.8”.

    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 1883 and 8081 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) › eclipse-mosquitto, App storage (fast) › eclipse-mosquitto › data and App storage (fast) › eclipse-mosquitto › config. 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–26

  8. Where the app's main data is saved

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

    Line 29

  9. Where the app's settings is saved

    Where the app's settings is saved on your server: App storage (fast) › eclipse-mosquitto › config.

    Line 30

  10. Broker port: 1883

    Publishes the app's broker port as 1883.

    Line 33

  11. Ws port: 8081

    Publishes the app's ws port as 8081.

    Line 34

  12. 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 36