A containerized Electrum server powered by Electrs.
Find a file
Foster Hangdaan 5caa3c4d41
Update README.org
- Added links to container registry.
- Added link for `LICENSE.md`.
2023-10-22 20:59:48 -04:00
.editorconfig Initial commit 2023-10-22 20:32:09 -04:00
Containerfile Initial commit 2023-10-22 20:32:09 -04:00
LICENSE.md Initial commit 2023-10-22 20:32:09 -04:00
README.org Update README.org 2023-10-22 20:59:48 -04:00

Electrum Container

About

A containerized Electrum server powered by Electrs. The server will allow you to connect Electrum wallets to your Bitcoin node.

See the container registry for a list of available versions.

Requirements

  • A synced, full-node Bitcoin daemon
  • Podman or Docker installed
  • Your router's port 50001 opened and forwarded

Usage

To run with podman run:

podman run -p 50001:50001 -v ./electrum/db:/electrs/db -v ./bitcoin-core/.bitcoin:/electrs/.bitcoin:ro code.fosterhangdaan.com/foster/electrum-container:0.10

Or define a compose.yaml file:

version: "3.8"

services:
  electrum:
    container_name: electrum
    image: code.fosterhangdaan.com/foster/electrum-container:0.10
    restart: unless-stopped
    volumes:
      # Database store
      - ./electrum/db:/electrs/db
      # Mount the blockchain from Bitcoin Core
      - ./bitcoin-core/.bitcoin:/electrs/.bitcoin:ro
    ports:
      - 50001:50001

Building

To build the image:

cd /path/to/electrum-container
podman build -t electrs .

Contributing

Please send patches and bug reports by email to one of the maintainers. See the Core Maintainers section for a list of contacts.

Refer to this guide if you are not familiar with sending Git patches over email.

Core Maintainers

License

Licensed under the Apache License, Version 2.0; see LICENSE.md for details.

Copyright

Copyright 2023 Foster Hangdaan