From 121e58e911c949df3e0bfbde589f125aceff27f9 Mon Sep 17 00:00:00 2001 From: Eugene Zagidullin Date: Thu, 13 Jun 2024 23:36:27 +0300 Subject: [PATCH] Readme updated --- README.md | 22 ++++++++++++++++++---- 1 file changed, 18 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8a94dad..a6e32b2 100644 --- a/README.md +++ b/README.md @@ -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