docker-electrumx/README.md
Frédéric Massart 0e68da0497 Upgrade to ElectrumX 1.8.7 (#10)
* Update to version 1.8.7 of ElectrumX

* Upgrade to Python 3.7

This is suggested in the release notes of ElectrumX:

"It is strongly recommended you upgrade to Python 3.7, which
fixes bugs in asyncio that caused an ever-growing open file count
and memory consumption whilst serving clients.  Those problems
should not occur with Python 3.7."

* Remove .py from the file to execute

* Rename Bitcoin to BitcoinSegwit as required by ElectrumX

* Travis to check version from new path
2019-01-29 21:48:05 +07:00

47 lines
1.4 KiB
Markdown

# docker-electrumx
[![Build Status](https://travis-ci.org/lukechilds/docker-electrumx.svg?branch=master)](https://travis-ci.org/lukechilds/docker-electrumx)
[![Image Layers](https://images.microbadger.com/badges/image/lukechilds/electrumx.svg)](https://microbadger.com/images/lukechilds/electrumx)
[![Docker Pulls](https://img.shields.io/docker/pulls/lukechilds/electrumx.svg)](https://hub.docker.com/r/lukechilds/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.
### 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=Bitcoin \
-p 50002:50002 \
lukechilds/electrumx:v1.2.1
```
## License
MIT © Luke Childs