Hexy Templates

Electrs

An efficient re-implementation of Electrum Server in Rust.

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

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 electrs 1.1.10”.

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

    Lines 13–20

  8. Auto-generated bitcoind rpc password

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

    Line 22

  9. Where the app's main data is saved

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

    Line 24

  10. Rpc port: 50001

    Publishes the app's rpc port as 50001.

    Line 27

  11. 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 29