Skip to content

Commit

Permalink
feat(docker): usability fixes (#212)
Browse files Browse the repository at this point in the history
* feat(docker): usability fixes

* docs(readme): release version roadmap
  • Loading branch information
revitteth authored Mar 20, 2024
1 parent 07a14be commit b489812
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 8 deletions.
11 changes: 8 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

cdk-erigon is a fork of Erigon, currently in Alpha, optimized for syncing with the Polygon Hermez zkEVM network.

***
## Release Roadmap
- **v0.9.x**: Support for Cardona testnet
- **v1.x.x**: Support for Mainnet
- **v3.x.x**: Erigon 3 based (snapshot support)

***

## Chain/Fork Support
Expand Down Expand Up @@ -76,9 +82,8 @@ The image comes with 3 preinstalled default configs which you may wish to edit a
A datadir must be mounted to the container to persist the chain data between runs.

Example commands:
- Mainnet `docker run -p 8545:8545 -v /datadirs:/datadirs hermeznetwork/cdk-erigon --config="./mainnet.yaml" --datadir='/datadirs/mainnet'`
- Cardona `docker run -p 8545:8545 -v /datadirs:/datadirs hermeznetwork/cdk-erigon --config="./cardona.yaml" --datadir='/datadirs/cardona'`
- Cardona Internal `docker run -p 8545:8545 -v /datadirs:/datadirs hermeznetwork/cdk-erigon --config="./cardona-internal.yaml" --datadir='/datadirs/cardona-internal'`
- Mainnet `docker run -p 8545:8545 -v ./cdk-erigon-data/:~/.cdk-erigon/data hermeznetwork/cdk-erigon --config="./mainnet.yaml"`
- Cardona `docker run -p 8545:8545 -v ./cdk-erigon-data/:~/.cdk-erigon/data hermeznetwork/cdk-erigon --config="./cardona.yaml"`

### Config
The examples are comprehensive but there are some key fields which will need setting e.g. `datadir`, and others you may wish to change
Expand Down
2 changes: 1 addition & 1 deletion hermezconfig-cardona-internal.yaml.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
datadir: ~/.cdk-erigon/hermez-cardona-internal
datadir: ~/.cdk-erigon/data
chain: hermez-cardona-internal
http: true
private.api.addr: localhost:9092
Expand Down
2 changes: 1 addition & 1 deletion hermezconfig-cardona.yaml.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
datadir: ~/.cdk-erigon/hermez-cardona
datadir: ~/.cdk-erigon/data
chain: hermez-cardona
http: true
private.api.addr: localhost:9092
Expand Down
2 changes: 1 addition & 1 deletion hermezconfig-dev.yaml.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
datadir: ~/.cdk-erigon/hermez-dev
datadir: ~/.cdk-erigon/data
chain: hermez-dev
http: true
private.api.addr: localhost:9093
Expand Down
2 changes: 1 addition & 1 deletion hermezconfig-etrog.yaml.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
datadir: ~/.cdk-erigon/hermez-etrog
datadir: ~/.cdk-erigon/data
chain: hermez-etrog
http: true
private.api.addr: localhost:9093
Expand Down
2 changes: 1 addition & 1 deletion hermezconfig-mainnet.yaml.example
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
datadir: ~/.cdk-erigon/hermez-mainnet
datadir: ~/.cdk-erigon/data
chain: hermez-mainnet
http: true
private.api.addr: localhost:9091
Expand Down

0 comments on commit b489812

Please sign in to comment.