Skip to content
Snippets Groups Projects
Commit c6a3e81f authored by Rohith's avatar Rohith
Browse files

- updating the readme with the correct help

parent 19020a43
No related branches found
No related tags found
No related merge requests found
...@@ -38,34 +38,39 @@ GLOBAL OPTIONS: ...@@ -38,34 +38,39 @@ GLOBAL OPTIONS:
--client-secret the client secret used to authenticate to the oauth server --client-secret the client secret used to authenticate to the oauth server
--client-id the client id used to authenticate to the oauth serves --client-id the client id used to authenticate to the oauth serves
--discovery-url the discovery url to retrieve the openid configuration --discovery-url the discovery url to retrieve the openid configuration
--scope [--scope option --scope option] a variable list of scopes requested when authenticating the user
--idle-duration "0" the expiration of the access token cookie, if not used within this time its removed
--redirection-url redirection url for the oauth callback url (/oauth is added)
--upstream-url "http://127.0.0.1:8081" the url for the upstream endpoint you wish to proxy to --upstream-url "http://127.0.0.1:8081" the url for the upstream endpoint you wish to proxy to
--revocation-url "/oauth2/revoke" the url for the revocation endpoint to revoke refresh token, not all providers support the revocation_endpoint --revocation-url "/oauth2/revoke" the url for the revocation endpoint to revoke refresh token
--upstream-keepalives enables or disables the keepalive connections for upstream endpoint (defaults true) --store-url url for the storage subsystem, e.g redis://127.0.0.1:6379, file:///etc/tokens.file
--encryption-key the encryption key used to encrpytion the session state --upstream-keepalives enables or disables the keepalive connections for upstream endpoint
--enable-refresh-tokens enables the handling of the refresh tokens
--secure-cookie enforces the cookie to be secure, default to true --secure-cookie enforces the cookie to be secure, default to true
--store-url the store url to use for storing the refresh tokens, i.e. redis://127.0.0.1:6379, file:///etc/tokens.file --cookie-access-name "kc-access" the name of the cookie use to hold the access token
--no-redirects do not have back redirects when no authentication is present, simple reply with 401 code --cookie-refresh-name "kc-state" the name of the cookie used to hold the encrypted refresh token
--redirection-url the redirection url, namely the site url, note: /oauth will be added to it --encryption-key the encryption key used to encrpytion the session state
--no-redirects do not have back redirects when no authentication is present, 401 them
--hostname [--hostname option --hostname option] a list of hostnames the service will respond to, defaults to all --hostname [--hostname option --hostname option] a list of hostnames the service will respond to, defaults to all
--tls-cert the path to a certificate file used for TLS --tls-cert the path to a certificate file used for TLS
--tls-private-key the path to the private key for TLS support --tls-private-key the path to the private key for TLS support
--tls-ca-certificate the path to the ca certificate used for mutual TLS --tls-ca-certificate the path to the ca certificate used for mutual TLS
--skip-upstream-tls-verify whether to skip the verification of any upstream TLS (defaults to true) --skip-upstream-tls-verify whether to skip the verification of any upstream TLS (defaults to true)
--scope [--scope option --scope option] a variable list of scopes requested when authenticating the user --match-claims [--match-claims option --match-claims option] keypair values for matching access token claims e.g. aud=myapp, iss=http://example.*
--claim [--claim option --claim option] a series of key pair values which must match the claims in the token present e.g. aud=myapp, iss=http://example.com etcd --add-claims [--add-claims option --add-claims option] retrieve extra claims from the token and inject into headers, e.g given_name -> X-Auth-Given-Name
--resource [--resource option --resource option] a list of resources 'uri=/admin|methods=GET|roles=role1,role2' --resource [--resource option --resource option] a list of resources 'uri=/admin|methods=GET|roles=role1,role2'
--signin-page a custom template displayed for signin --signin-page a custom template displayed for signin
--forbidden-page a custom template used for access forbidden --forbidden-page a custom template used for access forbidden
--tag [--tag option --tag option] a keypair tag which is passed to the templates when render, i.e. title='My Page',site='my name' etc --tag [--tag option --tag option] keypair's passed to the templates at render,e.g title='My Page'
--cors-origins [--cors-origins option --cors-origins option] a set of origins to add to the CORS access control (Access-Control-Allow-Origin) --cors-origins [--cors-origins option --cors-origins option] list of origins to add to the CORE origins control (Access-Control-Allow-Origin)
--cors-methods [--cors-methods option --cors-methods option] the method permitted in the access control (Access-Control-Allow-Methods) --cors-methods [--cors-methods option --cors-methods option] the method permitted in the access control (Access-Control-Allow-Methods)
--cors-headers [--cors-headers option --cors-headers option] a set of headers to add to the CORS access control (Access-Control-Allow-Headers) --cors-headers [--cors-headers option --cors-headers option] a set of headers to add to the CORS access control (Access-Control-Allow-Headers)
--cors-exposes-headers [--cors-exposes-headers option --cors-exposes-headers option] set the expose cors headers access control (Access-Control-Expose-Headers) --cors-exposes-headers [--cors-exposes-headers option --cors-exposes-headers option] set the expose cors headers access control (Access-Control-Expose-Headers)
--cors-max-age "0" the max age applied to cors headers (Access-Control-Max-Age) --cors-max-age "0" the max age applied to cors headers (Access-Control-Max-Age)
--cors-credentials the credentials access control header (Access-Control-Allow-Credentials) --cors-credentials the credentials access control header (Access-Control-Allow-Credentials)
--headers [--headers option --headers option] Add custom headers to the upstream request, key=value
--enable-security-filter enables the security filter handler --enable-security-filter enables the security filter handler
--skip-token-verification testing purposes ONLY, the option allows you to bypass the token verification, expiration and roles are still enforced --skip-token-verification TESTING ONLY; bypass's token verification, expiration and roles enforced
--proxy-protocol switches on proxy protocol support on the listen (not supported yet)
--offline-session enables the offline session of tokens via offline access (defaults false) --offline-session enables the offline session of tokens via offline access (defaults false)
--json-logging switch on json logging rather than text (defaults true) --json-logging switch on json logging rather than text (defaults true)
--log-requests switch on logging of all incoming requests (defaults true) --log-requests switch on logging of all incoming requests (defaults true)
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment