From 41a13fac4683c886c96437768207d73908914923 Mon Sep 17 00:00:00 2001 From: tommy kelly Date: Fri, 15 Oct 2021 09:26:12 -0400 Subject: [PATCH] added to the docs what env vars are --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 34b3940..9100df4 100644 --- a/README.md +++ b/README.md @@ -15,18 +15,18 @@ _Note_: the proxy should be used with care as any client that can access the API ## Usage [embedmd]:# (tmp/help.txt) -```txt + Usage of ./token-refresher: - --debug.name string A name to add as a prefix to log lines. (default "token-refresher") - --file string The path to the file in which to write the retrieved token. - --log.format string The log format to use. Options: 'logfmt', 'json'. (default "logfmt") - --log.level string The log filtering level. Options: 'error', 'warn', 'info', 'debug'. (default "info") - --margin duration The margin of time before a token expires to try to refresh it. (default 5m0s) - --oidc.audience string The audience for whom the access token is intended, see https://openid.net/specs/openid-connect-core-1_0.html#IDToken. - --oidc.client-id string The OIDC client ID, see https://tools.ietf.org/html/rfc6749#section-2.3. - --oidc.client-secret string The OIDC client secret, see https://tools.ietf.org/html/rfc6749#section-2.3. - --oidc.issuer-url string The OIDC issuer URL, see https://openid.net/specs/openid-connect-discovery-1_0.html#IssuerDiscovery. - --url string The target URL to which to proxy requests. All requests will have the acces token in the Authorization HTTP header. - --web.internal.listen string The address on which the internal server listens. (default ":8081") - --web.listen string The address on which the proxy server listens. (default ":8080") -``` +| args | type | env | default | description | +| --------------------- | -------- | ------------------- | --------------- | ---------------------------------------------------------------------------------------------------------------------- | +| --debug.name | string | | token-refresher | A name to add as a prefix to log lines. | +| --file | string | FILE | | The path to the file in which to write the retrieved token. | +| --log.format | string | LOG_FORMAT | logfmt | The log format to use. Options: 'logfmt', 'json'. | +| --log.level | string | LOG_LEVEL | info | The log filtering level. Options: 'error', 'warn', 'info', 'debug'. | +| --margin | duration | MARGIN | 5m0s | The margin of time before a token expires to try to refresh it | +| --oidc.audience | string | OIDC_AUDIENCE | | The audience for whom the access token is intended, see https://openid.net/specs/openid-connect-core-1_0.html#IDToken. | +| --oidc.client-secret | string | OIDC_CLIENT_SECRET | | The OIDC client secret, see https://tools.ietf.org/html/rfc6749#section-2.3. | +| --oidc.issuer-url | string | OIDC_ISSUER_URL | | The OIDC issuer URL, see https://openid.net/specs/openid-connect-discovery-1_0.html#IssuerDiscovery. | +| --url | string | URL | | The target URL to which to proxy requests. All requests will have the acces token in the Authorization HTTP header. | +| --web.internal.listen | string | WEB_INTERNAL_LISTEN | ":8081" | The address on which the internal server listens. | +| --web.listen | string | WEB_LISTEN | ":8080" | The address on which the proxy server listens. |