electrum/README.md

Intro

Electrum client is light bitcoin wallet software operates through supernodes (Electrum server instances actually).

Electrum client running as a daemon in docker container with JSON-RPC API enabled.

Usage

Here are some example snippets to help you get started creating a container.

docker-compose

services:
  electrum:
    build:
      context: https://git.bitdeals.org/private/electrum.git
      dockerfile: ./docker/Dockerfile
    image: registry.bitdeals.org/electrum
    environment:
      - ELECTRUM_TESTNET=0
      - ELECTRUM_API_USER=<username>
      - ELECTRUM_API_PASSWORD=<password>
    expose:
      - "7000"

docker cli

docker run -d \
  -e ELECTRUM_TESTNET=0 \
  -e ELECTRUM_API_USER=electrum_api_user \
  -e ELECTRUM_API_PASSWORD=electrum_api_password \
  -p 127.0.0.1:7000:7000 \
  registry.bitdeals.org/electrum

Parameters

Container images are configured using parameters passed at runtime.

Parameter	Function
-p 7000	JSON-RPC API port TCP
-e ELECTRUM_TESTNET=	Set 1 to enable bitcoin testnet mode. Default: 0
-e ELECTRUM_API_USER=	JSON-RPC API user. Default: electrum_api_user
-e ELECTRUM_API_PASSWORD=	JSON-RPC API password. Default: electrum_api_password
-e USER_UID=	Electrum user id. Default: 2000
-e USER_GID=	Electrum user gid. Default: 2000