Run an Electrum server with one command

Go to file

Luke Childs 43a81cf88f Remove RocksDB documentation from readme We don't need to document it here, it's already documented in the linked ElectrumX documentation.		2019-11-06 20:34:13 +07:00
bin	Upgrade to ElectrumX 1.8.7 (#10 )	2019-01-29 21:48:05 +07:00
.travis.yml	Remove version check on Travis	2019-05-16 07:22:53 +07:00
Dockerfile	Get leveldb-dev from main repository (#40 )	2019-11-05 15:52:08 +07:00
LICENSE	Initial commit	2017-09-19 16:46:51 +01:00
README.md	Remove RocksDB documentation from readme	2019-11-06 20:34:13 +07:00
VERSION	v1.13.0 (#39 )	2019-10-08 10:03:13 +07:00

README.md

docker-electrumx

Run an Electrum server with one command

An easily configurable Docker image for running an Electrum server.

Usage

docker run \
  -v /home/username/electrumx:/data \
  -e DAEMON_URL=http://user:pass@host:port \
  -e COIN=BitcoinSegwit \
  -p 50002:50002 \
  lukechilds/electrumx

If there's an SSL certificate/key (electrumx.crt/electrumx.key) in the /data volume it'll be used. If not, one will be generated for you.

You can view all ElectrumX environment variables here: https://github.com/kyuupichan/electrumx/blob/master/docs/environment.rst

TCP Port

By default only the SSL port is exposed. You can expose the unencrypted TCP port with -p 50001:50001, although this is strongly discouraged.

WebSocket Port

You can expose the WebSocket port with -p 50004:50004.

RPC Port

To access RPC from your host machine, you'll also need to expose port 8000. You probably only want this available to localhost: -p 127.0.0.1:8000:8000.

If you're only accessing RPC from within the container, there's no need to expose the RPC port.

Version

You can also run a specific version of ElectrumX if you want.

docker run \
  -v /home/username/electrumx:/data \
  -e DAEMON_URL=http://user:pass@host:port \
  -e COIN=BitcoinSegwit \
  -p 50002:50002 \
  lukechilds/electrumx:v1.8.7