Hexy Templates

nzbfast

nzbfast is a speed-focused Usenet (NZB) downloader with a web dashboard and a SABnzbd-compatible API.

Not yet tested media Based on TrueNAS app v1.0.12 (nzbfast 1.7.1)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find nzbfast and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
nzbfast.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS nzbfast 1.0.12"
6  },
37  "installation_questions": [
8    {
9      "question": "Api key",
10      "type": "password",
11      "key": "api_key",
12      "required": true
13    }
14  ],
15  "requirements": {
416    "locations": ["ApplicationsPerformance", "Downloads", "Media"],
517    "specifications": ["2CORE"],
618    "permissions": ["READ_WRITE_LOCATIONS"],
719    "ports": [30474]
20  },
821  "ensure_directories_exists": [
22    {"path": "$LOCATION(ApplicationsPerformance)"},
23    {"path": "$LOCATION(ApplicationsPerformance)/nzbfast"},
24    {"path": "$LOCATION(Downloads)", "network_share": true},
25    {"path": "$LOCATION(Media)", "network_share": true},
26    {
27      "path": "$LOCATION(ApplicationsPerformance)/nzbfast/config",
28      "owner": {"user": "apps"},
29      "snapshot": {"id": "config"}
30    },
31    {
32      "path": "$LOCATION(ApplicationsPerformance)/nzbfast/watch",
33      "owner": {"user": "apps"},
34      "snapshot": {"id": "watch"}
35    }
36  ],
37  "app_values": {
938    "nzbfast": {"api_key": "$QUESTION(api_key)"},
39    "storage": {
1040      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/nzbfast/config)",
1141      "downloads": "$HOST_PATH($LOCATION(Downloads))",
1242      "watch": "$HOST_PATH($LOCATION(ApplicationsPerformance)/nzbfast/watch)",
1343      "additional_storage": [
44        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
45      ]
46    },
47    "network": {
1448      "web_port": {"bind_mode": "published", "port_number": 30474}
49    },
1550    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
51  }
52}

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 nzbfast 1.0.12”.

    Lines 3–6

  3. Questions you'll be asked

    Before installing, HexOS will ask you for: Api key. Your answers are slotted into the settings further down wherever you see $QUESTION(...).

    Lines 7–14

  4. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast), Downloads and Media. If one isn't set up yet, HexOS will ask you to pick a place for it.

    Line 16

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 17

  6. Permission to use your folders

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

    Line 18

  7. Network ports

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

    Line 19

  8. Folders created on install

    Creates the folders the app needs before it starts: App storage (fast) › nzbfast, App storage (fast) › nzbfast › config and App storage (fast) › nzbfast › watch. 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 21–36

  9. Your answer: api key

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

    Line 38

  10. Where the app's settings is saved

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

    Line 40

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

    Where the app's “downloads” files is saved on your server: Downloads.

    Line 41

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

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

    Line 42

  13. Your shared folders

    Gives the app access to your existing files: Media appears inside the app as /media.

    Lines 43–45

  14. Web port: 30474

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

    Line 48

  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 50