Skip to content

Commit

Permalink
added to the docs what env vars are
Browse files Browse the repository at this point in the history
  • Loading branch information
@jpweber
tommy kelly authored and jpweber committed Feb 27, 2024
1 parent 027a87c commit 41a13fa
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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. |

0 comments on commit 41a13fa

Please sign in to comment.