Skip to content

Commit

Permalink
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix indentation of Docker section
Browse files Browse the repository at this point in the history
sisou authored Jan 9, 2025
1 parent c7ce3bf commit 6c288be
Showing 1 changed file with 12 additions and 7 deletions.
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -154,12 +154,17 @@ You can also choose to run a validator or a prover node. Check our guides with t
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.
- 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`.
- 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**
@@ -196,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 6c288be

Please sign in to comment.