From c7ce3bf11f7718f69d2dcb9496c9c069c9d6496a Mon Sep 17 00:00:00 2001 From: Jose Daniel Hernandez Date: Wed, 8 Jan 2025 10:27:04 -0600 Subject: [PATCH] Add documentation for running history nodes with Docker in mainnet Add documentation for running history nodes with Docker in mainnet. This is necessary since history nodes in mainnet need to use the full genesis file. This closes #3227. --- README.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index fe9ebfdd4b..d6a155a716 100644 --- a/README.md +++ b/README.md @@ -153,7 +153,12 @@ You can also choose to run a validator or a prover node. Check our guides with t `docker pull ghcr.io/nimiq/core-rs-albatross:latest`. 3. Create a `client.toml` file in `~/data` with `cp ./lib/src/config/config_file/client.example.toml ~/data/client.toml`. 4. Customize the configuration file to match your requirements. Refer to the [sample configuration file](https://github.com/nimiq/core-rs-albatross/blob/albatross/lib/src/config/config_file/client.example.toml) and [configuration settings](#configuration) for guidance. -5. Run the client via Docker: +5. Run the client via Docker. + - If you are running a history node for mainnet: + 1. Make sure to have downloaded the full genesis file as explained in [this section](#history-nodes). + 2. Copy the full genesis file into the `data` folder: `cp /path/to/nimiq-genesis-main-albatross.toml ~/data`. + 3. Run the client: `docker run -v $(pwd)/data:/home/nimiq/.nimiq -p 8443:8443 -p 8648:8648 -p 9100:9100 -e NIMIQ_OVERRIDE_MAINNET_CONFIG=/home/nimiq/.nimiq/nimiq-genesis-main-albatross.toml --name nimiq-rpc --rm ghcr.io/nimiq/core-rs-albatross:latest` + - If you're not running a history node or not running the client for mainnet: `docker run -v $(pwd)/data:/home/nimiq/.nimiq -p 8443:8443 -p 8648:8648 -p 9100:9100 --name nimiq-rpc --rm ghcr.io/nimiq/core-rs-albatross:latest`. **Overview of Exposed Ports**