electrs

Docker app from ofawx's Repository

Overview

Serve your Electrum clients from your own Bitcoin node! Avoid trusting public Electrum nodes, and maintain your own privacy.

Electrs does not support encrypted (SSL) communication, so avoid connecting directly to the TCP port over public networks (eg the Internet). Note that some clients, including Electrum, do not support connections without SSL. Consider using nginx as an SSL proxy (see link below for sample configuration). Electrs is designed for personal use only, and is not appropriate for serving a large number of clients.
If you have RPC enabled in Bitcoin Core without manually specifying an RPC user and password, Electrs can use Bitcoin's cookie file to auth automatically. If you have manually configured user and password in Bitcoin, these must also be set in Electrs manually. To do so, create a file called electrs.toml in the Electrs Data directory configured below. In this file, include the following data, substituting your own values for USER and PASSWORD: auth = "USER:PASSWORD"
See https://github.com/romanz/electrs/blob/master/doc/usage.md for full details on Electrs configuration.

Runtime arguments

Network
bridge
Shell
sh
Privileged
false

Template configuration

Electrum TCPPorttcp

Port to listen for incoming client connections

Target
50001
Default
50001
Value
50001
TCP BindVariable

Subnet to accept connections from, and port to listen on. Port must match above.

Target
ELECTRS_ELECTRUM_RPC_ADDR
Default
0.0.0.0:50001
Value
0.0.0.0:50001
Core RPC AddressVariable

Address for Bitcoin Core RPC.

Target
ELECTRS_DAEMON_RPC_ADDR
Default
192.168.1.1:8332
DataPathrw

Database storage. Requires at least 50 GiB free disk.

Target
/data/
Default
/mnt/user/bitcoin/electrs
Value
/mnt/user/bitcoin/electrs/
Bitcoin DataPathro

Bitcoin Core data directory. Read only.

Target
/data/.bitcoin/
Default
/mnt/user/bitcoin/core
Value
/mnt/user/bitcoin/core/

Download Statistics

17,789
Total Downloads
21
This Month
21
Avg / Month

Total Downloads Over Time

Loading chart...

Details

Repository
ofawx/electrs
Last Updated2021-10-14
First Seen2021-09-03

Run Electrs on Unraid.

Electrs is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.