Skip to content

Commit

Permalink
Merge pull request #45 from lidofinance/documentation
Browse files Browse the repository at this point in the history 
feat: fix documentation
  • Loading branch information
@sergeyWh1te
sergeyWh1te authored Oct 23, 2024
2 parents b2531b2 + f82cce3 commit d4072c3
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -103,21 +103,21 @@ To set up a local development environment for **Finding-Forwarder**, follow thes
```
- Configure your environment variables as needed. Below is an explanation of the available environment variables:

| Variable | Description | Default Value |
|------------------------|---------------------------------------------------------------------------------------------------|------------------------------------|
| `READ_ENV_FROM_SHELL` | Whether to read environment variables from the shell (useful for container setups). | `false` |
| `SOURCE` | Source name for identifying where the forwarder is running. | `local` |
| `ENV` | The environment mode of the application. | `local` |
| `APP_NAME` | Name of the application. | `finding_forwarder` |
| `PORT` | Port on which the application will run. | `8080` |
| `LOG_FORMAT` | Log format (`simple` or `json`). | `simple` |
| `LOG_LEVEL` | Log level (e.g., `debug`, `info`, `warn`, `error`). | `debug` |
| `BLOCK_TOPIC` | NATS topic for the Feeder to publish blockchain data. | `blocks.mainnet.l1` |
| `NATS_DEFAULT_URL` | URL for connecting to the NATS server. | `http://service-forta-nats:4222` |
| `REDIS_ADDRESS` | Address for connecting to the Redis instance. | `redis:6379` |
| `REDIS_DB` | Redis database index to use. | `0` |
| `QUORUM_SIZE` | The number of confirmations required before forwarding a message. | `1` |
| `JSON_RPC_URL` | URL for connecting to the Ethereum JSON-RPC endpoint. | `https://eth.drpc.org` |
| Variable | Description | Default Value |
|-------------------------|---------------------------------------------------------------------------------------------------|-------------------------------------|
| `READ_ENV_FROM_SHELL` | Whether to read environment variables from the shell (useful for container setups). | `false` |
| `SOURCE` | Source name for identifying where the forwarder is running. | `local` |
| `ENV` | The environment mode of the application. | `local` |
| `APP_NAME` | Name of the application. | `finding_forwarder` |
| `PORT` | Port on which the application will run. | `8080` |
| `LOG_FORMAT` | Log format (`simple` or `json`). | `simple` |
| `LOG_LEVEL` | Log level (e.g., `debug`, `info`, `warn`, `error`). | `debug` |
| `BLOCK_TOPIC` | NATS topic for the Feeder to publish blockchain data. | `blocks.mainnet.l1` |
| `NATS_DEFAULT_URL` | URL for connecting to the NATS server. | `http://service-forta-nats:4222` |
| `REDIS_ADDRESS` | Address for connecting to the Redis instance. | `redis:6379` |
| `REDIS_DB` | Redis database index to use. | `0` |
| `QUORUM_SIZE` | The number of confirmations required before forwarding a message. | `1` |
| `JSON_RPC_URL` | URL for connecting to the Ethereum JSON-RPC endpoint. | `https://eth.drpc.org` |

4. **Building and Running Bots**:
- Clone the **Testing Forta Bots** repository:
Expand Down

0 comments on commit d4072c3

Please sign in to comment.