mirror of https://github.com/mempool/mempool.git synced 2024-12-28 01:04:28 +01:00

History

hunicus 9a2043fab2 Remove $ from commands in repo docs		2022-05-09 02:35:03 -04:00
..
backend	Add the DOCKER_COMMIT_HASH env var to the backend Dockerfile	2022-03-23 12:16:21 -07:00
data	Add the empty directories needed by docker-compose	2022-01-10 20:31:36 -08:00
electrum	fixes to the electrum Dockerfile	2021-03-24 16:24:04 -07:00
frontend	Set Dockerfiles to use Node v16.10.0	2021-12-06 23:52:23 -08:00
mysql/data	Add the empty directories needed by docker-compose	2022-01-10 20:31:36 -08:00
scripts	Add script to pull digests from docker images (#705 )	2021-08-27 19:04:51 +09:00
docker-compose.yml	Normalize Docker environment variables and backend JSON keys	2022-01-12 21:20:14 -08:00
init.sh	Fetch the dereferenced commit from the tag	2022-01-12 22:36:24 -08:00
README.md	Remove $ from commands in repo docs	2022-05-09 02:35:03 -04:00

README.md

Docker Installation

This directory contains the Dockerfiles used to build and release the official images and a docker-compose.yml for end users to run a Mempool instance with minimal effort.

You can choose to configure Mempool to run with a basic backend powered by just bitcoind, or with bitcoind along with an Electrum-compatible server for full functionality.

`bitcoind`-only Configuration

Note: address lookups require an Electrum server and will not work with this configuration.

Make sure bitcoind is running and synced.

The default Docker configuration assumes you have added RPC credentials for a mempool user with a mempool password in your bitcoin.conf file, like so:

rpcuser=mempool
rpcpassword=mempool

If you want to use different credentials, specify them in the docker-compose.yml file:

  api:
    environment:
      MEMPOOL_BACKEND: "none"
      CORE_RPC_HOST: "172.27.0.1"
      CORE_RPC_PORT: "8332"
      CORE_RPC_USERNAME: "customuser"
      CORE_RPC_PASSWORD: "custompassword"

The IP address in the example above refers to Docker's default gateway IP address so that the container can hit the bitcoind instance running on the host machine. If your setup is different, update it accordingly.

Now, run:

docker-compose up

Your Mempool instance should be running at http://localhost. The graphs will be populated as new transactions are detected.

`bitcoind` + Electrum Server Configuration

First, configure bitcoind as specified above, and make sure your Electrum server is running and synced.

Then, make sure the following variables are set in docker-compose.yml, as shown below, so Mempool can connect to your Electrum server:

  api:
    environment:
      MEMPOOL_BACKEND: "electrum"
      ELECTRUM_HOST: "172.27.0.1"
      ELECTRUM_PORT: "50002"
      ELECTRUM_TLS_ENABLED: "false"

Of course, if your Docker host IP address is different, update accordingly.

With bitcoind and Electrum Server set up, run Mempool with:

docker-compose up

Further Configuration

Optionally, you can override any other backend settings from mempool-config.json.

Below we list all settings from mempool-config.json and the corresponding overrides you can make in the api > environment section of docker-compose.yml.

mempool-config.json:

  "MEMPOOL": {
    "NETWORK": "mainnet",
    "BACKEND": "electrum",
    "HTTP_PORT": 8999,
    "SPAWN_CLUSTER_PROCS": 0,
    "API_URL_PREFIX": "/api/v1/",
    "POLL_RATE_MS": 2000,
    "CACHE_DIR": "./cache",
    "CLEAR_PROTECTION_MINUTES": 20,
    "RECOMMENDED_FEE_PERCENTILE": 50,
    "BLOCK_WEIGHT_UNITS": 4000000,
    "INITIAL_BLOCKS_AMOUNT": 8,
    "MEMPOOL_BLOCKS_AMOUNT": 8,
    "PRICE_FEED_UPDATE_INTERVAL": 600,
    "USE_SECOND_NODE_FOR_MINFEE": false,
    "EXTERNAL_ASSETS": ["https://raw.githubusercontent.com/mempool/mining-pools/master/pools.json"],
    "STDOUT_LOG_MIN_PRIORITY": "info"
  },