Skip to content

Commit 7de5ba5

Browse files
committed
Added seed_db env variable to documentation
1 parent 0442ec6 commit 7de5ba5

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

README.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ These examples use the Leader and Follower addresses for testing locally with
7676
Sentry API will be accessible at `localhost:8005`
7777

7878
```bash
79-
IP_ADDR=127.0.0.1 REDIS_URL="redis://127.0.0.1:6379/1" \
79+
IP_ADDR=127.0.0.1 SEED_DB=true REDIS_URL="redis://127.0.0.1:6379/1" \
8080
POSTGRES_DB="sentry_leader" PORT=8005 KEYSTORE_PWD=ganache0 \
8181
cargo run -p sentry -- \
8282
--adapter ethereum \
@@ -89,7 +89,7 @@ cargo run -p sentry -- \
8989
Sentry API will be accessible at `localhost:8006`
9090

9191
```bash
92-
IP_ADDR=127.0.0.1 REDIS_URL="redis://127.0.0.1:6379/2" \
92+
IP_ADDR=127.0.0.1 SEED_DB=true REDIS_URL="redis://127.0.0.1:6379/2" \
9393
POSTGRES_DB="sentry_follower" PORT=8006 KEYSTORE_PWD=ganache1 cargo run -p sentry -- \
9494
--adapter ethereum \
9595
--keystoreFile ./adapter/tests/resources/0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7_keystore.json \
@@ -118,7 +118,7 @@ Request body (`JSON`):
118118
##### Leader (`0x80690751969B234697e9059e04ed72195c3507fa`)
119119

120120
```bash
121-
IP_ADDR=127.0.0.1 REDIS_URL="redis://127.0.0.1:6379/1" \
121+
IP_ADDR=127.0.0.1 SEED_DB=true REDIS_URL="redis://127.0.0.1:6379/1" \
122122
POSTGRES_DB="sentry_leader" PORT=8005 cargo run -p sentry -- \
123123
--adapter dummy \
124124
--dummyIdentity 0x80690751969B234697e9059e04ed72195c3507fa \
@@ -127,7 +127,7 @@ POSTGRES_DB="sentry_leader" PORT=8005 cargo run -p sentry -- \
127127
##### Follower (`0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7`)
128128

129129
```bash
130-
IP_ADDR=127.0.0.1 REDIS_URL="redis://127.0.0.1:6379/2" \
130+
IP_ADDR=127.0.0.1 SEED_DB=true REDIS_URL="redis://127.0.0.1:6379/2" \
131131
POSTGRES_DB="sentry_follower" PORT=8006 cargo run -p sentry -- \
132132
--adapter dummy \
133133
--dummyIdentity 0xf3f583AEC5f7C030722Fe992A5688557e1B86ef7 \
@@ -139,6 +139,7 @@ POSTGRES_DB="sentry_follower" PORT=8006 cargo run -p sentry -- \
139139
- `ENV` - `production` or `development`; *default*: `development` - passing this env. variable will use the default configuration paths - [`docs/config/ganache.toml`](./docs/config/ganache.toml) (for `development`) or [`docs/config/prod.toml`](./docs/config/prod.toml) (for `production`). Otherwise you can pass your own configuration file path to the binary (check `cargo run -p sentry --help` for more information). ~~In `development` it will make sure Sentry to seed the database~~ (seeding is disabled, see #514).
140140
- `PORT` - *default*: `8005` - The local port that Sentry API will be accessible at
141141
- `IP_ADDR` - *default*: `0.0.0.0` - the IP address that the API should be listening to
142+
- `SEED_DB` - *default*: `false` - Flag telling us whether we should seed the database, it can only be turned on for `development`
142143

143144
##### Adapter
144145

0 commit comments

Comments
 (0)