docs: Make it harder to screw up our manage.py commands.

This commit is contained in:
Tim Abbott 2017-02-03 12:46:58 -08:00
parent 43d343027b
commit 21f09dcab7
3 changed files with 16 additions and 10 deletions

View File

@ -84,10 +84,11 @@ These settings include:
- `EMAIL_*`, `DEFAULT_FROM_EMAIL`, and `NOREPLY_EMAIL_ADDRESS`:
Regardless of which authentication backends you enable, you must
provide settings for an outgoing SMTP server so Zulip can send
emails when needed (and don't forget to set `email_password` in
the `zulip-secrets.conf` file). We highly recommend testing
your configuration using `manage.py send_test_email` to confirm
your outgoing email configuration is working correctly.
emails when needed (and don't forget to set `email_password` in the
`zulip-secrets.conf` file). We highly recommend testing your
configuration using `su zulip` and then
`/home/zulip/deployments/current/manage.py send_test_email` to
confirm your outgoing email configuration is working correctly.
## Step 4: Initialize Zulip database
@ -109,16 +110,20 @@ in your Zulip installation.
## Step 5: Create a Zulip organization and login
* If you haven't already, verify that your server can send email using
`./manage.py send_test_email username@example.com`. You'll need
working outgoing email to complete the setup process.
```
su zulip
/home/zulip/deployments/current/manage.py send_test_email user@example.com
```
You'll need working outgoing email to complete the setup process.
* Run the organization (realm) creation [management
command](prod-maintain-secure-upgrade.html#management-commands) :
```
su zulip # If you weren't already the zulip user
cd /home/zulip/deployments/current
./manage.py generate_realm_creation_link
/home/zulip/deployments/current/manage.py generate_realm_creation_link
```
This will print out a secure 1-time use link that allows creation of a

View File

@ -11,7 +11,7 @@ import scripts.lib.setup_path_on_import
if __name__ == "__main__":
if 'posix' in os.name and os.geteuid() == 0:
from django.core.management.base import CommandError
raise CommandError("manage.py should not be run as root.")
raise CommandError("manage.py should not be run as root. Use `su zulip` to drop root.")
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "zproject.settings")
os.environ.setdefault("PYTHONSTARTUP", os.path.join(BASE_DIR, "scripts/lib/pythonrc.py"))

View File

@ -85,7 +85,8 @@ SSO_APPEND_DOMAIN = None # type: str
# https://support.google.com/mail/answer/14257.
#
# You can quickly test your sending email configuration using:
# ./manage.py send_test_email username@example.com
# su zulip
# /home/zulip/deployments/current/manage.py send_test_email username@example.com
#
# A common problem is hosting providers that block outgoing SMTP traffic.
#