From 6ae938e39e51080cc049b2aa5a95333513ce3b1c Mon Sep 17 00:00:00 2001 From: alvarobacelar Date: Sun, 16 May 2021 22:24:25 -0300 Subject: [PATCH] Add proxy and client CLI options --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 4fb194f..669ec6a 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,25 @@ If the target must be scraped over SSL/TLS, add: rather than the usual `scheme: https`. Only the default `scheme: http` works with the proxy, so this workaround is required. +## Proxy CLI Options + +| Option | Default | Description | +|--------|---------|-------------| +| --web.listen-address | 8080 | Address to listen on for proxy and client requests.| +| --scrape.max-timeout | 5m | Any scrape with a timeout higher than this will have to be clamped to this| +| --scrape.default-timeout | 15s | If a scrape lacks a timeout, use this value| + +## Client CLI Options + +| Option | Default | Description| +|--------|---------|------------| +| --proxy-url | | Push proxy to talk to| +| --fqdn | FQDN your host | FQDN to register with| +| --tls.cacert | | \ CA certificate to verify peer against | +| --tls.cert | | \ Client certificate file | +| --tls.key | | \ Private key file| +| --metrics-addr | | Serve Prometheus metrics at this address| + ## Service Discovery The `/clients` endpoint will return a list of all registered clients in the format