Hexy Templates

Bitcoin Node

Run your personal node powered by Bitcoin Core.

Not yet tested financial Based on TrueNAS app v1.1.16 (Bitcoin Node 31.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 Bitcoin Node and choose Custom Install
  3. 3
    Paste, then press Install — full guide with screenshots
bitcoind.json
Download 
1{
12  "version": 5,
23  "script": {
4    "version": "0.1.0",
5    "changeLog": "Auto-generated draft from TrueNAS bitcoind 1.1.16"
6  },
7  "requirements": {
38    "locations": ["ApplicationsPerformance"],
49    "specifications": ["2CORE"],
510    "permissions": ["READ_WRITE_LOCATIONS"],
611    "ports": [8332, 8333]
12  },
713  "ensure_directories_exists": [
14    {"path": "$LOCATION(ApplicationsPerformance)"},
15    {"path": "$LOCATION(ApplicationsPerformance)/bitcoind"},
16    {
17      "path": "$LOCATION(ApplicationsPerformance)/bitcoind/bitcoin",
18      "snapshot": {"id": "bitcoin"}
19    }
20  ],
21  "app_values": {
822    "bitcoin": {"rpc_password": "$RANDOM_STRING(16)"},
23    "storage": {
924      "bitcoin": "$HOST_PATH($LOCATION(ApplicationsPerformance)/bitcoind/bitcoin)"
25    },
26    "network": {
1027      "rpc_port": {"bind_mode": "published", "port_number": 8332},
1128      "p2p_clearnet_port": {
29        "bind_mode": "published",
30        "port_number": 8333
31      }
32    },
1233    "resources": {"limits": {"cpus": 2, "memory": "$MEMORY(10%, 4096)"}}
34  }
35}

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 1.1.16”.

    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 8332 and 8333 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 and App storage (fast) › bitcoind › bitcoin. Folders marked “snapshot” are included in HexOS snapshots, so you can roll them back.

    Lines 13–20

  8. Auto-generated rpc password

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

    Line 22

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

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

    Line 24

  10. Rpc port: 8332

    Publishes the app's rpc port as 8332.

    Line 27

  11. P2p clearnet port: 8333

    Publishes the app's p2p clearnet port as 8333.

    Lines 28–31

  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 33