From 23702614b2fb270e0d8da93cd41233b23a2696d5 Mon Sep 17 00:00:00 2001 From: Adham Helal Date: Fri, 19 Feb 2016 13:19:13 +0100 Subject: [PATCH] Update Read me --- README.md | 36 +++++++++++++++++++++++++++++++++++- 1 file changed, 35 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7ca4271..dac4a78 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,36 @@ # ansible-oauth2-proxy -An ansible role to install oauth2 proxy +An ansible role to install [oauth2 proxy](https://github.com/bitly/oauth2_proxy) + +Variables +--------- + +```yaml +oaut2_proxy_http : "https://github.com/bitly/oauth2_proxy/releases/download/v2.0.1/oauth2_proxy-2.0.1.linux-amd64.go1.4.2.tar.gz" +oaut2_proxy_http_sha256 : "c6d8f6d74e1958ce1688f3cf7d60648b9d0d6d4344d74c740c515a00b4e023ad" +oauth2_user : "oauth2" +oauth2_dir : "/var/oauth2_proxy" +oauth2_dir_tmp : "/var/oauth2_proxy/tmp" +oauth2_dir_log : "/var/log/oauth2-proxy/" +oauth2_config_path : "/var/oauth2_proxy/oauth2_config.cfg" +oauth2_compress_filename : "{{ oaut2_proxy_http | basename }}" +oauth2_filename : "{{ oauth2_compress_filename |replace('.tar.gz', '') }}" + +# See for all options https://raw.githubusercontent.com/bitly/oauth2_proxy/master/contrib/oauth2_proxy.cfg.example +oauth2_proxy_config : + http_address : "127.0.0.1:5000" + upstreams : [ "127.0.0.1:6060" ] + provider : "github" + email-domain : "*" + cookie-secure : false + cookie-domain : "localhost:5000" + cookie_secret : "COOK_SECRET" + client_id : "YOUR_CLIENT_ID" + client_secret : "CLIENT_SECERET" + +oauth2_config_cmdline_args : "-github-org='MYCoolORg'" +``` + + +License +-------- +MIT