Skip to content

Commit

Permalink
chore: README and example
Browse files Browse the repository at this point in the history
  • Loading branch information
vgorkavenko committed Oct 16, 2023
1 parent 69c6ff3 commit 59c6fd6
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 0 deletions.
1 change: 1 addition & 0 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -10,3 +10,4 @@ EXECUTION_CLIENT_URI=URL_TO_EL_API
# For option when KEYS_SOURCE is 'keys_file'
# CONSENSUS_CLIENT_URI: URL_TO_CL_API
# KEYS_SOURCE: file
# KEYS_FILE_PATH: path/to/keys.yml
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,13 @@ Currently it supports:
2. `poetry install`
3. `poetry run python -m src.main`

## Run with keys file

1. Fill `docker/validators/keys.yml` with your values
2. Set `KEYS_SOURCE=keys_file` in `.env`

> If you want to use another path, specify it in `KEYS_FILE_PATH` env variable
## Application Env variables

---
Expand All @@ -39,6 +46,7 @@ Currently it supports:
---
`KEYS_FILE_PATH` - Path to file with keys
* **Required:** if `KEYS_SOURCE` is `keys_file`
* **Default:** ./docker/validators/keys.yml
---
`CONSENSUS_CLIENT_URI` - Ethereum consensus layer comma separated API urls
* **Required:** true
Expand Down
2 changes: 2 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,9 @@ services:
- CONSENSUS_CLIENT_URI=${CONSENSUS_CLIENT_URI}
- EXECUTION_CLIENT_URI=${EXECUTION_CLIENT_URI}
- LIDO_LOCATOR_ADDRESS=${LIDO_LOCATOR}
- KEYS_SOURCE=${KEYS_SOURCE}
- KEYS_API_URI=${KEYS_API_URI}
- KEYS_FILE_PATH=${KEYS_FILE_PATH}
- ALERTMANAGER_URI=${ALERTMANAGER_URI}
- LOG_LEVEL=${LOG_LEVEL}
- DRY_RUN=${DRY_RUN}
Expand Down

0 comments on commit 59c6fd6

Please sign in to comment.