electrumx

electrumx

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. Expose ElectrumX to the public Internet to support other Electrum users who can't run their own nodes.

See https://github.com/spesmilo/electrumx/blob/master/docs/environment.rst for full details on ElectrumX environment configuration.

ElectrumX - python electrum server

Licence: MIT
Original Author: Neil Booth
Current Maintainers: The Electrum developers
Language: Python (>= 3.10)

Latest PyPI package Build Status

This project is a fork of kyuupichan/electrumx. The original author dropped support for Bitcoin, which we intend to keep.

ElectrumX allows users to run their own Electrum server. It connects to your full node and indexes the blockchain, allowing efficient querying of the history of arbitrary addresses. The server can be exposed publicly, and joined to the public network of servers via peer discovery. As of May 2020, a significant chunk of the public Electrum server network runs ElectrumX.

Documentation

See readthedocs.

Releases

Running from the latest git tag is always a safe bet, for which there are also releases on PyPI:

$ pip install e-x

Install Electrumx on Unraid in a few clicks.

Find Electrumx in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Electrumx Review the template variables and paths Click Install

Download Statistics

18,317
Total Downloads
5
This Month
18
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Details

Repository
ofawx/electrumx
Last Updated2021-09-04
First Seen2021-09-04

Runtime arguments

Network
bridge
Shell
sh
Privileged
false

Template configuration

DataPathrw

Database Storage

Target
/data
Default
/mnt/user/bitcoin/electrumx/
Value
/mnt/user/bitcoin/electrumx/
Core RPCVariable

Bitcoin RPC (Auth and Address)

Target
DAEMON_URL
Default
user:pass@host:8332
Value
user:pass@host:8332
CoinVariable

Container Variable: COIN

Target
COIN
Default
BitcoinSegwit
Value
BitcoinSegwit
TCPPorttcp

Electrum TCP

Target
50001
Default
50001
Value
50001
SSLPorttcp

Electrum SSL

Target
50002
Default
50002
Value
50002
WSSPorttcp

Electrum WSS

Target
50004
Default
50004
Value
50004
RPCPorttcp

ElectrumX RPC

Target
8000
Default
8000
Value
8000
Banner FileVariable

Place a text file to be displayed to clients in the data directory above

Target
BANNER_FILE
Default
/data/banner.txt
Value
/data/banner.txt
Donation AddressVariable

Your Bitcoin address to display to clients for donations

Target
DONATION_ADDRESS
Default
bc1q5g4e6auucmwzj5cwfc7870yn4cg0dselhpn47p
Value
bc1q5g4e6auucmwzj5cwfc7870yn4cg0dselhpn47p
ServicesVariable

Services and ports to bind. Must match ports above.

Target
SERVICES
Default
tcp://:50001,ssl://:50002,wss://:50004,rpc://
Value
tcp://:50001,ssl://:50002,wss://:50004,rpc://0.0.0.0
Report ServicesVariable

Optionally advertise FQDNs where your ElectrumX is available

Target
REPORT_SERVICES
Default
ssl://my.electrum.duckdns.org:50002,wss://my.electrum.duckdns.org:50004