Skip to content

Commit

Permalink
Readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
e-asphyx committed Jun 13, 2024
1 parent 47d94b4 commit 121e58e
Showing 1 changed file with 18 additions and 4 deletions.
22 changes: 18 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,26 +33,40 @@ The purpose of the `/health` endpoint is to allow health check probes from load
### Installation

1. Clone the repository:

```bash
git clone https://github.com/ecadlabs/octez-ecad-sc.git
cd octez-ecad-sc
```

2. Build the project:

```bash
go build -o octez-ecad-sc
```

3. Run the sidecar:

```bash
./octez-ecad-sc --additional-time-window 10
./octez-ecad-sc -c config.yaml
```

### Configuration

The sidecar can be configured via command line flags:

- `--additional-time-window`: The amount of time added to the `minimal_block_delay` value for block observation (default: 10 seconds).
The sidecar can be configured via YAML file:

| Field | Default | Description |
| ------------------ | ------- | --------------------------------------------------------------------------------- |
| listen | :8080 | Host and port to listen on |
| url | | Tezos RPC URL |
| chain_id | | Base58 encoded chain id |
| timeout | 30s | RPC timeout |
| tolerance | 10s | The amount of time added to the `minimal_block_delay` value for block observation |
| reconnect_delay | 10s | Delay before reconnection of a head monitor |
| use_timestamps | false | Use blocks' timestamps instead of a system time |
| check_block_delay | true | |
| check_bootstrapped | true | |
| check_sync_state | true | |

### Reporting Issues

Expand Down

0 comments on commit 121e58e

Please sign in to comment.