From fc9fcb075aa806e53b4143f7d3dd1b2d982b3ccc Mon Sep 17 00:00:00 2001 From: Sean McGary Date: Tue, 4 Jun 2024 11:25:47 -0500 Subject: [PATCH] Update readme --- README.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/README.md b/README.md index 87a0e77..a17ce6f 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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`