electrs-docker

A Dockerfile to Build from the Source

Note: This image is intended to connect to a local running Bitcoin node only.

References:

• Electrs repo: https://github.com/romanz/electrs
• Docker images: https://hub.docker.com/r/waltersouto/electrs

How to use

Start cloning this repository. In the repository directory, copy the file env.example to .env and edit it according to your environment.

To build the image, run the following command:

docker build -t <your-docker-hub-user>/electrs:<tag> .

You can run the container with the docker run command or with docker compose since a compose.yml file is provided.

Here is the run command (don't forget to edit the .env file):

docker run --rm \
--name electrs \
--env-file=.env \
-e ELECTRS_DB_DIR=${DB_DIR} \
-e ELECTRS_DAEMON_DIR=${DAEMON_DIR} \
-e ELECTRS_NETWORK=bitcoin \
-e ELECTRS_LOG_FILTERS=INFO \
-e ELECTRS_SERVER_BANNER="${BANNER}" \
-e ELECTRS_DAEMON_RPC_ADDR=${BTC_ADDR}:${BTC_RPC_PORT} \
-e ELECTRS_DAEMON_P2P_ADDR=${BTC_ADDR}:${BTC_P2P_PORT} \
-e ELECTRS_ELECTRUM_RPC_ADDR=${HOST_ADDR}:${HOST_PORT} \
-v ${HOST_BITCOIN_DIR}:${DAEMON_DIR}:ro \
-v ${HOST_ELECTRS_DIR}:/data \
-p ${HOST_PORT}:50001 \
${DOCKER_USER}/electrs:${TAG}

There is also a file run.sh containing the command.

To push the image to the registry:

docker push <your-docker-hub-user>/electrs:<tag>

After the build is done, use the docker-compose.yml to run the image:

docker compose up