From e9d1fe1ed019852ff7425b73072a8b695ebd3ef3 Mon Sep 17 00:00:00 2001 From: Evgeny Gusarov Date: Wed, 13 Nov 2024 15:38:16 +0300 Subject: [PATCH] Add docker info in README.md --- .gitignore | 4 +++- README.md | 22 +++++++++++++++++++--- 2 files changed, 22 insertions(+), 4 deletions(-) diff --git a/.gitignore b/.gitignore index 82f9275..fc2db1b 100644 --- a/.gitignore +++ b/.gitignore @@ -159,4 +159,6 @@ cython_debug/ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore # and can be added to the global gitignore or merged into this file. For a more nuclear # option (not recommended) you can uncomment the following to ignore the entire idea folder. -#.idea/ +.idea/ + +.vscode diff --git a/README.md b/README.md index 4cc108d..d3d0087 100644 --- a/README.md +++ b/README.md @@ -9,20 +9,36 @@ DVT sidecar: 2. Polls validator exits from Relayer 3. Pushes exit signature shares to Relayer on behalf of DVT operators. -## Setup +## Run in docker + +1. `cp .env.example .env` +2. Fill .env file with appropriate values +3. Run container + +```shell +docker run \ +-u $(id -u):$(id -g) \ +--env-file .env \ +-v $(pwd)/data:/data \ +europe-west4-docker.pkg.dev/stakewiselabs/public/dvt-operator-sidecar:v0.4.2 +``` + +## Development + +### Setup 1. Install [poetry](https://python-poetry.org/) 2. `poetry install` 3. `cp .env.example .env` 4. Fill .env file with appropriate values -## Run +### Run 1. `poetry shell` 2. `export PYTHONPATH=.` 3. `python src/app.py` -## Testing +### Testing This section is about integration testing, when sidecar works in conjunction with DVT Relayer and Stakewise Operator.