Skip to content

Commit 91ea295

Browse files
committed
README - fix link and clean up
1 parent 0192245 commit 91ea295

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Components:
88

99
* [Sentry](#sentry)
1010
* [Validator worker](#validator-worker)
11-
* Adapter
11+
* Adapter - Ethereum & Dummy (for testing) Adapters
1212
* AdView manager
1313

1414
## Local & Testing setup
@@ -32,10 +32,10 @@ We need two services to be able to run `Sentry`: `Postgres` and `Redis`.
3232

3333
### Running Postgres
3434

35-
`docker run --rm --name adex-validator-postgres -e POSTGRES_PASSWORD=docker -d -p 5432:5432 -v $HOME/docker/volumes/postgres:/var/lib/postgresql/data postgres`
35+
`docker run --rm --name adex-validator-postgres -e POSTGRES_PASSWORD=postgres -d -p 5432:5432 -v $HOME/docker/volumes/postgres:/var/lib/postgresql/data postgres`
3636

3737
- `$HOME/docker/volumes/postgres` - your local storage for postgres (persist the data when we remove the container)
38-
- `POSTGRES_PASSWORD=docker` - the password of `postgres` user
38+
- `POSTGRES_PASSWORD=postgres` - the password of `postgres` user
3939

4040
### Running Redis
4141

@@ -73,7 +73,7 @@ The password for the Keystore file can be set using the [environment variable `K
7373
./docs/config/dev.toml
7474
```
7575

76-
#### Using the `Dummy Adapter`:
76+
#### Using the `Dummy Adapter`
7777

7878
**Dummy** identities:
7979

@@ -94,9 +94,9 @@ The password for the Keystore file can be set using the [environment variable `K
9494
./docs/config/dev.toml
9595
```
9696

97-
For full list, check out (primitives/src/util/tests/prep_db.rs#L29-L43)[./primitives/src/util/tests/prep_db.rs#L29-L43]
97+
For full list, check out [primitives/src/util/tests/prep_db.rs#L29-L43](./primitives/src/util/tests/prep_db.rs#L29-L43)
9898

99-
#### Environment variables:
99+
#### Environment variables
100100

101101
- `ENV` - `production` or `development`; *default*: `development` - passing this env. variable will use the default configuration paths - [`docs/config/dev.toml`](./docs/config/dev.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.
102102
- `PORT` - *default*: `8005` - The local port that Sentry API will be accessible at
@@ -124,7 +124,7 @@ For a full list of all available CLI options on the Validator worker run `--help
124124
cargo run -p validator_worker -- --help
125125
```
126126

127-
#### Using the `Ethereum Adapter`:
127+
#### Using the `Ethereum Adapter`
128128
TODO: Update Keystore file and Keystore password for Leader/Follower as they are using the same at the moment.
129129

130130
The password for the Keystore file can be set using the environment variable `KEYSTORE_PWD`.
@@ -152,7 +152,7 @@ The password for the Keystore file can be set using the environment variable `KE
152152
./docs/config/dev.toml
153153
```
154154

155-
#### Using the `Dummy Adapter`:
155+
#### Using the `Dummy Adapter`
156156
- Leader: `ce07CbB7e054514D590a0262C93070D838bFBA2e`
157157

158158
Assuming you have [Sentry API running](#running-sentry-rest-api) for the **Leader** on port `8005`:
@@ -177,7 +177,7 @@ The password for the Keystore file can be set using the environment variable `KE
177177
./docs/config/dev.toml
178178
```
179179

180-
#### Environment variables:
180+
#### Environment variables
181181

182182
- `ENV`: `production` or `development` ( *default* ) - passing this env. variable will use the default configuration paths - [`docs/config/dev.toml`](./docs/config/dev.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.
183183
- `PORT` - The local port that Sentry API will accessible at

0 commit comments

Comments
 (0)