reddcoincore/electrumx repository overview

⁠reddcoincore/electrumx

This repo packages the Reddcoin fork of ElectrumX⁠ into a Docker image for linux/amd64 and linux/arm64. It serves Electrum clients such as Redd-Electrum⁠ and needs a fully synced reddcoind⁠ node with RPC enabled — the reddcoincore/reddcoind⁠ image works well for this.

⁠Tags

• latest — most recent build from master
• v<version> (e.g. v1.20.1) — built from the matching tag of reddcoin-project/electrumx⁠, with a matching GitHub Release⁠

⁠Usage

⁠Pull

docker pull reddcoincore/electrumx

⁠Run

docker run -d \
  --name reddcoin-electrumx \
  -v /path/to/electrumx:/data \
  -e COIN=Reddcoin \
  -e DAEMON_URL=http://rpcuser:rpcpassword@reddcoind-host:45443 \
  -p 50002:50002 \
  reddcoincore/electrumx

DAEMON_URL must point at the RPC interface of your reddcoind node (the default Reddcoin mainnet RPC port is 45443). Make sure reddcoind allows RPC connections from the ElectrumX container (rpcallowip).

On first start ElectrumX indexes the whole Reddcoin chain into /data, which takes a while. Clients can connect once it has caught up with the node.

⁠Docker Compose

Running reddcoind and ElectrumX side by side on a private network:

services:
  reddcoin-server:
    container_name: reddcoin-server
    image: reddcoincore/reddcoind:v4.22.9
    restart: on-failure
    volumes:
      - ./data/reddcoin:/home/reddcoind/.reddcoin
    environment:
      - RPC_SERVER=1
      - RPC_USERNAME=rpcuser
      - RPC_PASSWORD=change-me
      - RPC_PORT=45443
      - RPC_ALLOW_IP=172.28.0.0/16
    stop_grace_period: 5m
    networks:
      - reddnet

  reddcoin-electrumx:
    container_name: reddcoin-electrumx
    image: reddcoincore/electrumx:latest
    restart: always
    volumes:
      - ./data/electrumx:/data
    environment:
      - COIN=Reddcoin
      - DAEMON_URL=http://rpcuser:change-me@reddcoin-server:45443
      - REPORT_SERVICES=ssl://electrum.example.com:50002,wss://electrum.example.com:50004
    ports:
      - "50002:50002"
      - "50004:50004"
    networks:
      - reddnet

networks:
  reddnet:
    ipam:
      config:
        - subnet: 172.28.0.0/16

Set REPORT_SERVICES to the public hostname of your server so it can be announced to peers and clients.

⁠Configuration

The image sets these defaults, all of which can be overridden with -e:

All ElectrumX environment variables are documented here: https://electrumx-spesmilo.readthedocs.io/en/latest/environment.html⁠

⁠SSL certificate

If there's an SSL certificate/key (electrumx.crt/electrumx.key) in the /data volume it'll be used. If not, a self-signed one will be generated on first start.

⁠Ports

To use the RPC interface from inside the container there's no need to expose the port:

docker exec reddcoin-electrumx electrumx_rpc getinfo

⁠Version

To run a specific version, use its tag:

docker run \
  -v /path/to/electrumx:/data \
  -e COIN=Reddcoin \
  -e DAEMON_URL=http://rpcuser:rpcpassword@reddcoind-host:45443 \
  -p 50002:50002 \
  reddcoincore/electrumx:v1.20.1

⁠Building

docker build --build-arg VERSION=1.20.1 -t reddcoincore/electrumx:v1.20.1 .

VERSION is a branch or tag of reddcoin-project/electrumx⁠.

⁠Releasing

1. Bump ARG VERSION in the Dockerfile⁠ and push to master — this⁠ builds and publishes latest.

2. Tag the commit with the same version and push the tag:

   git tag -a v1.20.1 -m "ElectrumX 1.20.1"
   git push origin v1.20.1
   

   Copy

   This⁠ checks the tag matches the Dockerfile, publishes reddcoincore/electrumx:v1.20.1 and creates the GitHub Release.

⁠License

MIT © Luke Childs, Reddcoin Core Developers