Docker Installation

$ git clone https://github.com/ferritecoin/fecspace
$ cd fecspace/docker

Install Docker on Ubuntu

# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "$VERSION_CODENAME") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin
sudo apt install docker-compose

This directory contains the Dockerfiles used to build and release the official images, as well as a docker-compose.yml to configure environment variables and other settings.

If you are looking to use these Docker images to deploy your own instance of Mempool, note that they only containerize Mempool's frontend and backend. You will still need to deploy and configure Bitcoin Core and an Electrum Server separately, along with any other utilities specific to your use case (e.g., a reverse proxy, etc). Such configuration is mostly beyond the scope of the Mempool project, so please only proceed if you know what you're doing.

See a video guide of this installation method by k3tan on BitcoinTV.com.

Jump to a section in this doc:

Configure with Ferrite Core + electrum-fec Server
Configure with Ferrite Core only
Further Configuration

Configure with Ferrite Core + electrs-fec Server (Default setting)

First, configure ferrited as specified above, and make sure your Electrum Server is running and synced. See this FAQ if you need help picking an Electrum Server implementation.

Then, set the following variables in docker-compose.yml so Mempool can connect to your Electrum Server:

  api:
    environment:
      MEMPOOL_BACKEND: "esplora"
      ELECTRUM_HOST: "127.0.0.1"
      ELECTRUM_PORT: "50011"
      ELECTRUM_TLS_ENABLED: "false"

Eligible values for MEMPOOL_BACKEND:

"esplora" if you're using ferritecoin/electrs-fec
~~"electrum" if you're using romanz/electrs or cculianu/Fulcrum~~
"none" if you're not using any Electrum Server -> see Configure with Ferrite Core

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

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

sudo docker-compose up

Configure with Ferrite Core only

Note: address lookups require an Electrum Server and will not work with this configuration. Add an Electrum Server to your backend for full functionality.

The default Docker configuration assumes you have the following configuration in your ferrite.conf file:

txindex=1
server=1
rpcuser=user
rpcpassword=password

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

  api:
    environment:
      MEMPOOL_BACKEND: "none"
      CORE_RPC_HOST: "127.0.0.1"
      CORE_RPC_PORT: "9573"
      CORE_RPC_USERNAME: "user"
      CORE_RPC_PASSWORD: "password"
      CORE_RPC_TIMEOUT: "60000"

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

Make sure ferrited is running and synced.

Now, run:

sudo docker-compose up

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

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",
    "ENABLED": true,
    "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,
    "BLOCKS_SUMMARIES_INDEXING": false,
    "USE_SECOND_NODE_FOR_MINFEE": false,
    "EXTERNAL_ASSETS": [],
    "STDOUT_LOG_MIN_PRIORITY": "info",
    "INDEXING_BLOCKS_AMOUNT": false,
    "AUTOMATIC_BLOCK_REINDEXING": false,
    "POOLS_JSON_URL": "https://raw.githubusercontent.com/mempool/mining-pools/master/pools-v2.json",
    "POOLS_JSON_TREE_URL": "https://api.github.com/repos/mempool/mining-pools/git/trees/master",
    "ADVANCED_GBT_AUDIT": false,
    "ADVANCED_GBT_MEMPOOL": false,
    "CPFP_INDEXING": false,
    "MAX_BLOCKS_BULK_QUERY": 0,
    "DISK_CACHE_BLOCK_INTERVAL": 6
  },