Skip to content

fix: README first-run instructions reference a nonexistent keygen service #3

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
batuhankocyigit wants to merge 2 commits into
base: main
Choose a base branch
from
Open

fix: README first-run instructions reference a nonexistent keygen service #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3f1ce6a
fix: README first-run instructions reference a nonexistent keygen ser…
batuhankocyigit Aug 21, 2026
7c462eb
Remove redundant entrypoint in Docker command
batuhankocyigit Aug 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ NODE_COMPOSE := docker-compose.yml
MONITORING_COMPOSE := docker-compose.monitoring.yml
FULL_COMPOSE := docker compose -f $(NODE_COMPOSE) -f $(MONITORING_COMPOSE)

.PHONY: help hash-password up down restart logs status validate snapshot init-keys
.PHONY: help hash-password up down restart logs status validate snapshot gen-key

help: ## Show available targets
@grep -hE '^[a-zA-Z_-]+:.*## ' $(MAKEFILE_LIST) | awk -F':.*## ' '{printf " %-16s %s\n", $$1, $$2}'
Expand Down
12 changes: 8 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ then:

```bash
# generate the validator key by writing config/keystore.json + config/validator_key.json
docker compose run --rm --no-deps -it keygen
docker run --rm -it \
--entrypoint /bin/cli \
-v "$(pwd)/config:/app/config" \
canopynetwork/canopy:latest \
new-validator-key --data-dir /app/config

# validators only: modify the "externalAddress" field in config/config.json to point to your domain
# config/config.json → "externalAddress": "tcp://<your-domain>"
Expand All @@ -27,12 +31,12 @@ docker compose run --rm --no-deps -it keygen
docker compose up -d
```

If you also copy the `Makefile`, the equivalent shortcuts are `make init-keys` and `make up` (see
If you also copy the `Makefile`, the equivalent shortcuts are `make gen-key` and `make up` (see
[Operations](#operations)).

### Migrating an existing validator

Skip `keygen`. Instead, copy your existing `config.json`, `keystore.json`, and `validator_key.json`
Skip the key generation step above. Instead, copy your existing `config.json`, `keystore.json`, and `validator_key.json`
into `config/` before running `docker compose up -d`.

You may also need to update `config.json` so `rpcURL` is `"/rpc"` and `adminRPCUrl` is
Expand Down Expand Up @@ -110,7 +114,7 @@ enabled in config (enabled by default).
## Repo layout

```
docker-compose.yml # node (+ keygen, run once via `docker compose run keygen`)
docker-compose.yml # node (+ validator key generation, run once via `make gen-key`)
docker-compose.monitoring.yml # caddy + monitoring stack (configs inlined via `configs:`)
config/ # node config + genesis (bind-mounted into the node)
data/ # runtime state (peers, chain db), gitignored
Expand Down