From 94574df274834609b4f132cc88fdc75c94313c30 Mon Sep 17 00:00:00 2001 From: Hans Kristian Flaatten Date: Tue, 5 Sep 2017 22:58:53 +0200 Subject: [PATCH] Clarify that GitHub team slug name should be used for the `-github-team` option --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ce371f4..ae0dac2 100644 --- a/README.md +++ b/README.md @@ -99,7 +99,7 @@ The Azure AD auth provider uses `openid` as it default scope. It uses `https://g The GitHub auth provider supports two additional parameters to restrict authentication to Organization or Team level access. Restricting by org and team is normally accompanied with `--email-domain=*` -github-org="": restrict logins to members of this organisation - -github-team="": restrict logins to members of any of these teams, separated by a comma + -github-team="": restrict logins to members of any of these teams (slug), separated by a comma If you are using GitHub enterprise, make sure you set the following to the appropriate url: @@ -176,7 +176,7 @@ Usage of oauth2_proxy: -email-domain value: authenticate emails with the specified domain (may be given multiple times). Use * to authenticate any email -footer string: custom footer string. Use "-" to disable default footer. -github-org string: restrict logins to members of this organisation - -github-team string: restrict logins to members of this team + -github-team string: restrict logins to members of any of these teams (slug), separated by a comma -google-admin-email string: the google admin to impersonate for api calls -google-group value: restrict logins to members of this google group (may be given multiple times). -google-service-account-json string: the path to the service account json credentials