From eef66ee031e8b40530ab1152053ea7aebe69dd41 Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Fri, 29 Jul 2016 12:34:17 -0700 Subject: [PATCH] Document GitHub authentication. --- zproject/prod_settings_template.py | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/zproject/prod_settings_template.py b/zproject/prod_settings_template.py index 7723b1820c..25c86690e6 100644 --- a/zproject/prod_settings_template.py +++ b/zproject/prod_settings_template.py @@ -25,6 +25,7 @@ ADMIN_DOMAIN = 'example.com' AUTHENTICATION_BACKENDS = ( # 'zproject.backends.EmailAuthBackend', # Email and password; see SMTP setup below # 'zproject.backends.GoogleMobileOauth2Backend', # Google Apps, setup below +# 'zproject.backends.GitHubAuthBackend', # GitHub auth, setup below # 'zproject.backends.ZulipLDAPAuthBackend', # LDAP, setup below # 'zproject.backends.ZulipRemoteUserBackend', # Local SSO, setup docs on readthedocs ) @@ -43,6 +44,19 @@ AUTHENTICATION_BACKENDS = ( # zulip-secrets.conf, and your client ID right here: # GOOGLE_OAUTH2_CLIENT_ID= + +# To enable GitHub authentication, you will need to need to do the following: +# +# (1) Register an OAuth2 application with GitHub at one of: +# https://github.com/settings/applications +# https://github.com/organizations/ORGNAME/settings/applications +# Specify e.g. https://zulip.example.com/complete/github/ as the callback URL. +# +# (2) Put your "Client ID" as SOCIAL_AUTH_GITHUB_KEY below and your +# "Client secret" as social_auth_github_secret in +# /etc/zulip/zulip-secrets.conf. +# SOCIAL_AUTH_GITHUB_KEY = + # If you are using the ZulipRemoteUserBackend authentication backend, # set this to your domain (e.g. if REMOTE_USER is "username" and the # corresponding email address is "username@example.com", set