From bf5a96ce1375930741a793c73791a0649531cc74 Mon Sep 17 00:00:00 2001 From: Hamza Hamud <53880692+hhamud@users.noreply.github.com> Date: Wed, 24 Dec 2025 20:20:00 +0000 Subject: [PATCH] docs: refine docker guide config generation command --- DOCKER_GUIDE.md | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/DOCKER_GUIDE.md b/DOCKER_GUIDE.md index 074c1ac..1554028 100644 --- a/DOCKER_GUIDE.md +++ b/DOCKER_GUIDE.md @@ -33,17 +33,20 @@ sudo ufw reload Quilibrium nodes require a valid configuration and cryptographic keys to participate in the network. For containerized deployments, it is recommended to generate these separately from the main node execution. -### Why Separate Config Generation? -1. **Security**: Sensitive key generation is handled explicitly as a separate step. -2. **Immutability**: Pre-generated configurations can be mounted as read-only volumes, following container best practices. -3. **Stability**: Ensures consistent network settings (like UDP/QUIC-v1) before the node starts. - ### Generating Config You can use the `config-gen` utility included in the Docker image or build it from source. +**Using Go (from repo root):** +```bash +go run ./utils/config-gen --config $(pwd)/.config +``` + **Using Docker:** ```bash -docker run --rm -v $(pwd)/.config:/root/.config quilibrium --target node-only config-gen --config /root/.config +docker run --rm -it \ + --entrypoint config-gen \ + -v $(pwd)/.config:/root/.config \ + quilibrium --config /root/.config ``` ## 3. Build from Source