Hexy Templates

Spottarr

Spottarr is a small application that can index the spotnet messages (spots) and exposes them as a newznab indexer.

Not yet tested networking Based on TrueNAS app v1.1.12 (Spottarr 1.20.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 Spottarr and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
spottarr.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS spottarr 1.1.12"
6  },
37  "installation_questions": [
8    {
9      "question": "Username",
10      "type": "text",
11      "key": "username",
12      "required": true
13    },
14    {
15      "question": "Password",
16      "type": "password",
17      "key": "password",
18      "required": true
19    }
20  ],
21  "requirements": {
422    "locations": ["ApplicationsPerformance"],
523    "specifications": ["2CORE"],
624    "permissions": ["READ_WRITE_LOCATIONS"],
725    "ports": [30151]
26  },
827  "ensure_directories_exists": [
28    {"path": "$LOCATION(ApplicationsPerformance)"},
29    {"path": "$LOCATION(ApplicationsPerformance)/spottarr"},
30    {
31      "path": "$LOCATION(ApplicationsPerformance)/spottarr/data",
32      "owner": {"user": "apps"},
33      "snapshot": {"id": "data"}
34    }
35  ],
36  "app_values": {
37    "spottarr": {
38      "usenet": {
939        "hostname": "$SERVER_LAN_IP",
1040        "username": "$QUESTION(username)",
1141        "password": "$QUESTION(password)"
42      }
43    },
44    "storage": {
1245      "data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/spottarr/data)"
46    },
47    "network": {
1348      "web_port": {"bind_mode": "published", "port_number": 30151}
49    },
1450    "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 spottarr 1.1.12”.

    Lines 3–6

  3. Questions you'll be asked

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

    Lines 7–20

  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 22

  5. Minimum hardware

    Recommended minimum: 2 CPU cores.

    Line 23

  6. Permission to use your folders

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

    Line 24

  7. Network ports

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

    Line 25

  8. Folders created on install

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

  9. Your server's address (hostname)

    Automatically set to your server's address on your home network (your-server-ip).

    Line 39

  10. Your answer: username

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

    Line 40

  11. Your answer: password

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

    Line 41

  12. Where the app's main data is saved

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

    Line 45

  13. Web port: 30151

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

    Line 48

  14. 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