oauth2_proxy/contrib/oauth2_proxy.cfg.example

91 lines
3.3 KiB
Plaintext
Raw Normal View History

2015-05-26 13:18:03 +00:00
## OAuth2 Proxy Config File
## https://github.com/bitly/oauth2_proxy
2014-11-09 19:51:10 +00:00
2015-06-08 01:51:47 +00:00
## <addr>:<port> to listen on for HTTP/HTTPS clients
2014-11-09 19:51:10 +00:00
# http_address = "127.0.0.1:4180"
2015-06-08 01:51:47 +00:00
# https_address = ":443"
## TLS Settings
# tls_cert_file = ""
# tls_key_file = ""
2014-11-09 19:51:10 +00:00
## the OAuth Redirect URL.
2015-03-17 20:25:19 +00:00
# defaults to the "https://" + requested host header + "/oauth2/callback"
2014-11-09 19:51:10 +00:00
# redirect_url = "https://internalapp.yourcompany.com/oauth2/callback"
## the http url(s) of the upstream endpoint. If multiple, routing is based on path
# upstreams = [
# "http://127.0.0.1:8080/"
# ]
## Logging configuration
#logging_filename = ""
#logging_max_size = 100
#logging_max_age = 7
#logging_local_time = true
#logging_compress = false
#standard_logging = true
#standard_logging_format = "[{{.Timestamp}}] [{{.File}}] {{.Message}}"
#request_logging = true
#request_logging_format = "{{.Client}} - {{.Username}} [{{.Timestamp}}] {{.Host}} {{.RequestMethod}} {{.Upstream}} {{.RequestURI}} {{.Protocol}} {{.UserAgent}} {{.StatusCode}} {{.ResponseSize}} {{.RequestDuration}}"
#auth_logging = true
#auth_logging_format = "{{.Client}} - {{.Username}} [{{.Timestamp}}] [{{.Status}}] {{.Message}}"
2014-11-09 19:51:10 +00:00
## pass HTTP Basic Auth, X-Forwarded-User and X-Forwarded-Email information to upstream
# pass_basic_auth = true
# pass_user_headers = true
2015-03-17 19:15:15 +00:00
## pass the request Host Header to upstream
## when disabled the upstream Host is used as the Host Header
# pass_host_header = true
2014-11-09 19:51:10 +00:00
## Email Domains to allow authentication for (this authorizes any email on this domain)
## for more granular authorization use `authenticated_emails_file`
## To authorize any email addresses use "*"
# email_domains = [
2014-11-09 19:51:10 +00:00
# "yourcompany.com"
# ]
2015-05-26 13:18:03 +00:00
## The OAuth Client ID, Secret
2014-11-09 19:51:10 +00:00
# client_id = "123456.apps.googleusercontent.com"
# client_secret = ""
2015-05-26 13:18:03 +00:00
## Pass OAuth Access token to upstream via "X-Forwarded-Access-Token"
# pass_access_token = false
2014-11-09 19:51:10 +00:00
## Authenticated Email Addresses File (one email per line)
# authenticated_emails_file = ""
## Htpasswd File (optional)
## Additionally authenticate against a htpasswd file. Entries must be created with "htpasswd -s" for SHA encryption
## enabling exposes a username/login signin form
# htpasswd_file = ""
2015-03-17 22:06:06 +00:00
## Templates
## optional directory with custom sign_in.html and error.html
# custom_templates_dir = ""
## skip SSL checking for HTTPS requests
# ssl_insecure_skip_verify = false
2014-11-09 19:51:10 +00:00
## Cookie Settings
## Name - the cookie name
## Secret - the seed string for secure cookies; should be 16, 24, or 32 bytes
## for use with an AES cipher when cookie_refresh or pass_access_token
## is set
## Domain - (optional) cookie domain to force cookies to (ie: .yourcompany.com)
## Expire - (duration) expire timeframe for cookie
## Refresh - (duration) refresh the cookie when duration has elapsed after cookie was initially set.
## Should be less than cookie_expire; set to 0 to disable.
## On refresh, OAuth token is re-validated.
## (ie: 1h means tokens are refreshed on request 1hr+ after it was set)
## Secure - secure cookies are only sent by the browser of a HTTPS connection (recommended)
2015-05-26 13:18:03 +00:00
## HttpOnly - httponly cookies are not readable by javascript (recommended)
# cookie_name = "_oauth2_proxy"
2014-11-09 19:51:10 +00:00
# cookie_secret = ""
# cookie_domain = ""
# cookie_expire = "168h"
2015-05-26 13:18:03 +00:00
# cookie_refresh = ""
2015-03-18 03:13:45 +00:00
# cookie_secure = true
# cookie_httponly = true