paulmataruso/zulip
1
0
Fork 0
mirror of https://github.com/zulip/zulip.git synced 2025-11-03 13:33:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Turn SSO auth documentation into general auth page.

Browse Source 
Also remove this page from the breadcrumb.
This commit is contained in:
Tim Abbott
2016-07-12 16:05:04 -07:00
parent 6ed73b430a
commit 6301fd22dc
2 changed files with 25 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/index.rst
View File

@@ -53,7 +53,7 @@ Contents:
prod-health-check-debug
prod-customize
prod-maintain-secure-upgrade
prod-remote-user-sso-auth
prod-authentication-methods
prod-postgres
.. _tutorial-docs:

32
docs/prod-remote-user-sso-auth.md → docs/prod-authentication-methods.md
View File

@@ -1,10 +1,28 @@
Remote User SSO Authentication
==============================
# Supported authentication methods
Zulip supports integrating with a corporate Single-Sign-On solution.
There are a few ways to do it, but this section documents how to
configure Zulip to use an SSO solution that best supports Apache and
will set the `REMOTE_USER` variable:
Zulip supports several different authentications methods:
* `EmailAuthBackend` - Email/password authentication.
* `ZulipLDAPAuthBackend` - LDAP username/password authentication.
* `GoogleMobileOauth2Backend` - Google authentication.
* `ZulipRemoteUserBackend` - Authentication using an existing
Single-Sign-On (SSO) system that can set REMOTE_USER in Apache.
* `DevAuthBackend` - Only for development, passwordless login as any user.
* Likely more coming (e.g. there's work on [GitHub auth](https://github.com/zulip/zulip/issues/1042)).
The setup documentation for most of these is simple enough that we've
included it inline in `/etc/zulip/settings.py`, right above to the
settings used to configure them. The remote user authentication
backend is more complex since it requires interfacing with a generic
third-party authentication system, and so we've documented it in
detail here.
## Remote User SSO Authentication
Zulip supports integrating with a Single-Sign-On solution. There are
a few ways to do it, but this section documents how to configure Zulip
to use an SSO solution that best supports Apache and will set the
`REMOTE_USER` variable:
(0) Check that `/etc/zulip/settings.py` has
`zproject.backends.ZulipRemoteUserBackend` as the only enabled value
@@ -104,5 +122,3 @@ understanding what's going on as you try to debug:
Again, most issues with this setup tend to be subtle issues with the
hostname/DNS side of the configuration. Suggestions for how to
improve this SSO setup documentation are very welcome!
Next: [Postgres database details](prod-postgres.html).