Hexy Templates

Bitcoin Knots

Run your personal node powered by Bitcoin Knots.

Not yet tested financial Based on TrueNAS app v1.1.15 (Bitcoin Knots v29.4.2)
Project website TrueNAS app source Script on GitHub Report a problem
  1. 1
    Copy the script below
  2. 2
    In HexOS, open Apps, find Bitcoin Knots and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
bitcoind-knots.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS bitcoind-knots 1.1.15"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [30240, 30241]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/bitcoind-knots"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/bitcoind-knots/bitcoin",
18      "owner": {"user": "apps"},
19      "snapshot": {"id": "bitcoin"}
20    }
21  ],
22  "app_values": {
823    "bitcoin": {"rpc_password": "$RANDOM_STRING(16)"},
24    "storage": {
925      "bitcoin": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bitcoind-knots/bitcoin)"
26    },
27    "network": {
1028      "rpc_port": {"bind_mode": "published", "port_number": 30240},
1129      "p2p_clearnet_port": {
30        "bind_mode": "published",
31        "port_number": 30241
32      }
33    },
1234    "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 bitcoind-knots 1.1.15”.

    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 30240 and 30241 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) › bitcoind-knots and App storage (fast) › bitcoind-knots › bitcoin. 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 rpc password

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

    Line 23

  9. Where the app's “bitcoin” files is saved

    Where the app's “bitcoin” files is saved on your server: App storage (fast) › bitcoind-knots › bitcoin.

    Line 25

  10. Rpc port: 30240

    Publishes the app's rpc port as 30240.

    Line 28

  11. P2p clearnet port: 30241

    Publishes the app's p2p clearnet port as 30241.

    Lines 29–32

  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 34