Hexy Templates

nexsift

The filter for your homelab's notifications. Services report to nexsift instead of to your phone, through doors that answer like Gotify, ntfy, a Discord webhook, SMTP or syslog. nexsift sorts everything into one inbox, bundles the routine and passes on only what matters, through ntfy, Gotify, Telegram, Apprise, a webhook or Web Push.

Not yet tested productivity Based on TrueNAS app v1.0.1 (nexsift 0.6.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 nexsift and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
nexsift.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS nexsift 1.0.1"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30510, 30511, 30512, 30513, 30514]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/nexsift"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/nexsift/data",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "data"}
20    }
21  ],
22  "app_values": {
823    "nexsift": {"secret_key": "$RANDOM_STRING(32)"},
24    "storage": {
925      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/nexsift/data)"
26    },
27    "network": {
1028      "web_port": {"bind_mode": "published", "port_number": 30510},
1129      "gotify_port": {"bind_mode": "published", "port_number": 30511},
1230      "ntfy_port": {"bind_mode": "published", "port_number": 30512},
1331      "smtp_port": {"bind_mode": "published", "port_number": 30513},
1432      "syslog_port": {"bind_mode": "published", "port_number": 30514}
33    },
1534    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
35  }
36}

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 nexsift 1.0.1”.

    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 30510, 30511, 30512, 30513 and 30514 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) › nexsift and App storage (fast) › nexsift › 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–21

  8. Auto-generated secret key

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

    Line 23

  9. Where the app's main data is saved

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

    Line 25

  10. Web port: 30510

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

    Line 28

  11. Gotify port: 30511

    Publishes the app's gotify port as 30511.

    Line 29

  12. Ntfy port: 30512

    Publishes the app's ntfy port as 30512.

    Line 30

  13. Smtp port: 30513

    Publishes the app's smtp port as 30513.

    Line 31

  14. Syslog port: 30514

    Publishes the app's syslog port as 30514.

    Line 32

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