Files
electrumx-docker/README.md
Bill 87fe23f01a
Some checks failed
Build / build (push) Failing after 3m1s
Updated docker usage
2024-09-17 21:44:32 -04:00

34 lines
871 B
Markdown

# electrumx-docker
Docker image for running an Electrum server.
## Usage
```
electrum:
image: git.prettyhefty.com/bill/electrumx-docker:1.16.0
restart: unless-stopped
container_name: electrum
environment:
- COIN=Bitcoin
- DAEMON_URL=username:password@bitcoin-core
volumes:
- ${DATA_DIR}/electrum:/db
```
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.
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. Expose the unencrypted TCP port with `-p 50001:50001`.
### WebSocket Port
Expose the WebSocket port with `-p 50004:50004`.
### RPC Port
To access RPC from your host machine, expose port 8000: `-p 127.0.0.1:8000:8000`.