From 415da352df19100226f8b2dc0cda26cd80bae152 Mon Sep 17 00:00:00 2001 From: Greg Price Date: Tue, 17 Oct 2017 16:58:24 -0700 Subject: [PATCH] prod install: Cut premature suggestion to configure auth backends. The warning here means that the admin can't really act on this yet if they want to disable email auth, which is likely among admins that want to make any changes here. And for admins who don't, this is an extra thing to read and make a decision about before they can get a server running. See #6985. Conversely, we already discuss auth backends right at the top of the `prod-customize` doc, which is linked under "Next steps" at the end of these instructions. The warning about EmailAuthBackend is important; but we can move it to the config file right next to the setting, and then it's available right when it's actionable, which is if the admin is actually thinking about changing the setting. --- docs/prod-install.md | 6 ------ zproject/prod_settings_template.py | 4 ++++ 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/docs/prod-install.md b/docs/prod-install.md index faf6426101..36e5af3d74 100644 --- a/docs/prod-install.md +++ b/docs/prod-install.md @@ -90,12 +90,6 @@ heading `### MANDATORY SETTINGS`. These settings include: [our guide for outgoing email](prod-email.html) for help configuring this. -- If desired, you can also configure additional - [authentication backends](prod-authentication-methods.html) while - you're editing /etc/zulip/settings.py. Note, however, that the - default (email) backend must be enabled when you complete Step 6 - (creating an organization) below. - ## Step 4: Test email configuration [Test your outgoing email configuration](prod-email.html#testing-and-troubleshooting). diff --git a/zproject/prod_settings_template.py b/zproject/prod_settings_template.py index 883f833ce9..9e0af2846d 100644 --- a/zproject/prod_settings_template.py +++ b/zproject/prod_settings_template.py @@ -89,6 +89,10 @@ EMAIL_USE_TLS = True # Enable at least one of the following authentication backends. # See http://zulip.readthedocs.io/en/latest/prod-authentication-methods.html # for documentation on our authentication backends. +# +# The install process requires EmailAuthBackend (the default) to be +# enabled. If you want to disable it, do so after creating the +# initial realm and user. AUTHENTICATION_BACKENDS = ( 'zproject.backends.EmailAuthBackend', # Email and password; just requires SMTP setup # 'zproject.backends.GoogleMobileOauth2Backend', # Google Apps, setup below