67 lines
2.3 KiB
Markdown
67 lines
2.3 KiB
Markdown
|
|
# docker-electrumx
|
|
|
|
[](https://travis-ci.org/lukechilds/docker-electrumx)
|
|
[](https://microbadger.com/images/lukechilds/electrumx)
|
|
[](https://hub.docker.com/r/lukechilds/electrumx/)
|
|
[](https://github.com/sponsors/lukechilds)
|
|
[](https://blockstream.info/address/3Luke2qRn5iLj4NiFrvLBu2jaEj7JeMR6w)
|
|
[](https://tippin.me/@lukechilds?refurl=github.com/lukechilds/docker-electrumx)
|
|
|
|
> Run an Electrum server with one command
|
|
|
|
An easily configurable Docker image for running an Electrum server.
|
|
|
|
## Usage
|
|
|
|
Create a Docker volume to store the data, and then run the container
|
|
|
|
|
|
```
|
|
docker volume create electrumx
|
|
|
|
docker run \
|
|
-d --network="host"
|
|
-v electrumx:/data \
|
|
-e DAEMON_URL=http://user:pass@127.0.0.1:7313 \
|
|
-e COIN=FLO \
|
|
ranchimallfze/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/spesmilo/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
|
|
|
|
**Note - this feature is to be finished for RanchiMall's FLO 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
|
|
```
|
|
|
|
## License
|
|
|
|
MIT © Luke Childs
|