Skip to content
This repository has been archived by the owner on Dec 7, 2020. It is now read-only.

Commit

Permalink
README
Browse files Browse the repository at this point in the history 
- removing the duplicate usage
  • Loading branch information
@gambol99
gambol99 committed Dec 6, 2016
1 parent 7d7b091 commit 0aac920
Showing 1 changed file with 0 additions and 77 deletions.
77 changes: 0 additions & 77 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,83 +100,6 @@ GLOBAL OPTIONS:
--verbose switch on debug / verbose logging
--help, -h show help
--version, -v print the version
NAME:
keycloak-proxy - is a proxy using the keycloak service for auth and authorization
USAGE:
keycloak-proxy [options]
VERSION:
v1.2.7 (git+sha: fe9654c)
AUTHOR(S):
Rohith <gambol99@gmail.com>
COMMANDS:
help, h Shows a list of commands or help for one command
GLOBAL OPTIONS:
--config value the path to the configuration file for the keycloak proxy [$PROXY_CONFIG_FILE]
--listen value the interface the service should be listening on [$PROXY_LISTEN]
--client-secret value the client secret used to authenticate to the oauth server (access_type: confidential) [$PROXY_CLIENT_SECRET]
--client-id value the client id used to authenticate to the oauth service [$PROXY_CLIENT_ID]
--discovery-url value the discovery url to retrieve the openid configuration [$PROXY_DISCOVERY_URL]
--scope value a variable list of scopes requested when authenticating the user
--token-validate-only validate the token and roles only, no required implement oauth
--redirection-url value redirection url for the oauth callback url (/oauth is added) [$PROXY_REDIRECTION_URL]
--revocation-url value the url for the revocation endpoint to revoke refresh token [$PROXY_REVOCATION_URL]
--store-url value url for the storage subsystem, e.g redis://127.0.0.1:6379, file:///etc/tokens.file [$PROXY_STORE_URL]
--upstream-url value the url for the upstream endpoint you wish to proxy to [$PROXY_UPSTREAM_URL]
--upstream-keepalives enables or disables the keepalive connections for upstream endpoint
--upstream-timeout value is the maximum amount of time a dial will wait for a connect to complete (default: 10s)
--upstream-keepalive-timeout value specifies the keep-alive period for an active network connection (default: 10s)
--enable-authorization-header adds the authorization header to the proxy request
--enable-refresh-tokens enables the handling of the refresh tokens
--secure-cookie enforces the cookie to be secure, default to true
--http-only-cookie enforces the cookie is in http only mode, default to false
--cookie-domain value a domain the access cookie is available to, defaults host header
--cookie-access-name value the name of the cookie use to hold the access token (default: "kc-access")
--cookie-refresh-name value the name of the cookie used to hold the encrypted refresh token (default: "kc-state")
--encryption-key value the encryption key used to encrpytion the session state
--no-redirects do not have back redirects when no authentication is present, 401 them
--hostname value a list of hostnames the service will respond to, defaults to all
--enable-metrics enable the prometheus metrics collector on /oauth/metrics
--localhost-only-metrics enforces the metrics page can only been requested from 127.0.0.1
--enable-proxy-protocol whether to enable proxy protocol
--enable-forwarding enables the forwarding proxy mode, signing outbound request
--forwarding-username value the username to use when logging into the openid provider
--forwarding-password value the password to use when logging into the openid provider
--forwarding-domains value a list of domains which should be signed; everything else is relayed unsigned
--tls-cert value the path to a certificate file used for TLS
--tls-private-key value the path to the private key for TLS support
--tls-ca-certificate value the path to the ca certificate used for mutual TLS
--tls-ca-key value the path the ca private key, used by the forward signing proxy
--tls-client-certificate value the path to the client certificate, used to outbound connections in reverse and forwarding proxy modes
--skip-upstream-tls-verify whether to skip the verification of any upstream TLS (defaults to true)
--skip-openid-provider-tls-verify whether to skip the verification of any TLS communication with the openid provider (defaults to false)
--match-claims value keypair values for matching access token claims e.g. aud=myapp, iss=http://example.*
--add-claims value retrieve extra claims from the token and inject into headers, e.g given_name -> X-Auth-Given-Name
--resource value a list of resources 'uri=/admin|methods=GET,PUT|roles=role1,role2'
--headers value Add custom headers to the upstream request, key=value
--signin-page value a custom template displayed for signin
--forbidden-page value a custom template used for access forbidden
--tag value keypair's passed to the templates at render,e.g title='My Page'
--cors-origins value list of origins to add to the CORE origins control (Access-Control-Allow-Origin)
--cors-methods value the method permitted in the access control (Access-Control-Allow-Methods)
--cors-headers value a set of headers to add to the CORS access control (Access-Control-Allow-Headers)
--cors-exposes-headers value set the expose cors headers access control (Access-Control-Expose-Headers)
--cors-max-age value the max age applied to cors headers (Access-Control-Max-Age) (default: 0s)
--cors-credentials the credentials access control header (Access-Control-Allow-Credentials)
--enable-security-filter enables the security filter handler
--skip-token-verification TESTING ONLY; bypass token verification, only expiration and roles enforced
--json-logging switch on json logging rather than text (defaults true)
--log-requests switch on logging of all incoming requests (defaults true)
--verbose switch on debug / verbose logging
--help, -h show help
--version, -v print the version
```
#### **Building**
Expand Down

0 comments on commit 0aac920

Please sign in to comment.