Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
seanmcgary committed Jun 4, 2024
1 parent 2182efe commit fc9fcb0
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,16 @@ docker run eigenlayer-rewards-updater:latest [updater]

## Running

### Public docker image

A publicly hosted Docker image can be found at:

```bash
public.ecr.aws/z6g0f8n7/eigenlayer-rewards-updater:latest
```

This image is a multi-arch capable image, currently built for `linux/amd64` and `linux/arm64`. `latest` is the only tag available at the moment with plans to ship versioned images soon.

### With config

To run the `rewards-updater` with a config file, copy the `config.yml.tpl` template to your desired location and fill in the specified fields.
Expand Down Expand Up @@ -103,10 +113,24 @@ Optional, path to a file based config to use

### `--debug`

EnvVar: `EIGENLAYER_DEBUG`

*Values:* `true, false`

Enables debug logging

### --enable-statsd

EnvVar: `EIGENLAYER_ENABLE_STATSD`

Enable/disable statsd metrics collection. Defaults to `true` and will attempt to auto-detect the DataDog statsd collection agent from the environment.

### --enable-tracing

EnvVar: `EIGENLAYER_ENABLE_TRACING`

Enable/disable tracing. Defaults to `true` and will attempt to auto-detect the DataDog tracing agent from the environment.

## Updater

### `--environment`
Expand Down

0 comments on commit fc9fcb0

Please sign in to comment.