48 lines
1.1 KiB
Markdown
48 lines
1.1 KiB
Markdown
# Intro
|
|
|
|
[Electrum client](https://electrum.org/) 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
|
|
|
|
```yaml
|
|
version: "3"
|
|
services:
|
|
electrum:
|
|
image: bitdeals/electrum
|
|
environment:
|
|
- ELECTRUM_TESTNET=0
|
|
- ELECTRUM_API_USER=<username>
|
|
- ELECTRUM_API_PASSWORD=<password>
|
|
ports:
|
|
- 7000:7000
|
|
```
|
|
|
|
## docker cli
|
|
|
|
```sh
|
|
docker run -d \
|
|
-e ELECTRUM_TESTNET=0 \
|
|
-e ELECTRUM_API_USER=api \
|
|
-e ELECTRUM_API_PASSWORD=changeme \
|
|
-p 127.0.0.1:7000:7000 \
|
|
bitdeals/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: `api`|
|
|
|-e ELECTRUM_API_PASSWORD=|JSON-RPC API password. Default: `changeme`|
|
|
|