Hexy Templates

Bitmagnet

Bitmagnet is a self-hosted BitTorrent indexer, DHT crawler, content classifier and torrent search engine with web UI, GraphQL API and Servarr stack integration.

Not yet tested media Based on TrueNAS app v1.2.32 (Bitmagnet v0.10.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 Bitmagnet and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
bitmagnet.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS bitmagnet 1.2.32"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance", "Media"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30177, 30178]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/bitmagnet"},
16    {"path": "$LOCATION(Media)", "network_share": true},
17    {
18      "path": "$LOCATION(ApplicationsPerformance)/bitmagnet/config",
19      "owner": {"user": "apps"},
20      "snapshot": {"id": "config"}
21    },
22    {
23      "path": "$LOCATION(ApplicationsPerformance)/bitmagnet/postgres_data",
24      "owner": {"user": "netdata", "group": "docker"},
25      "snapshot": {"id": "postgres_data"}
26    }
27  ],
28  "app_values": {
829    "bitmagnet": {"db_password": "$RANDOM_STRING(16)"},
30    "storage": {
931      "config": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bitmagnet/config)",
1032      "postgres_data": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bitmagnet/postgres_data)",
1133      "additional_storage": [
34        "$MOUNTED_HOST_PATH($LOCATION(Media), /media)"
35      ]
36    },
37    "network": {
1238      "web_port": {"bind_mode": "published", "port_number": 30177},
1339      "dht_server_port": {
40        "bind_mode": "published",
41        "port_number": 30178
42      }
43    },
1444    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
45  }
46}

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 bitmagnet 1.2.32”.

    Lines 3–6

  3. Storage locations it needs

    The app uses these HexOS storage locations: App storage (fast) and Media. 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 30177 and 30178 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) › bitmagnet, App storage (fast) › bitmagnet › config and App storage (fast) › bitmagnet › postgres_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–27

  8. Auto-generated db password

    HexOS makes up a long random db password during install. It's only used inside Bitmagnet, so you never need to know it.

    Line 29

  9. Where the app's settings is saved

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

    Line 31

  10. Where the app's database is saved

    Where the app's database is saved on your server: App storage (fast) › bitmagnet › postgres_data.

    Line 32

  11. Your shared folders

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

    Lines 33–35

  12. Web port: 30177

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

    Line 38

  13. Dht server port: 30178

    Publishes the app's dht server port as 30178.

    Lines 39–42

  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 44