Skip to content

Commit

Permalink
Add documentation for running history nodes with Docker in mainnet
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
jsdanielh committed Jan 10, 2025
1 parent 7c82820 commit 28a73ca
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,8 +153,18 @@ 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:
`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`.
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 with the `NIMIQ_OVERRIDE_MAINNET_CONFIG` environment variable:
```
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**
Expand Down Expand Up @@ -191,4 +201,4 @@ Small note: When editing the README, please conform to the [standard-readme](htt
## License
This project is licensed under the [Apache License 2.0](./LICENSE.md).
This project is licensed under the [Apache License 2.0](./LICENSE.md).

0 comments on commit 28a73ca

Please sign in to comment.