docs: Document the REALM_HOSTS feature.

This commit is contained in:
Tim Abbott
2018-05-16 07:02:13 -07:00
parent ee0f1992bf
commit 828104e020

View File

@@ -47,6 +47,24 @@ For servers hosting a large number of organizations, like
`ROOT_DOMAIN_LANDING_PAGE = True` in `/etc/zulip/settings.py` so that `ROOT_DOMAIN_LANDING_PAGE = True` in `/etc/zulip/settings.py` so that
the homepage for the server is a copy of the Zulip homepage. the homepage for the server is a copy of the Zulip homepage.
### Other hostnames
If you'd like to use hostnames that are not subdomains of each other,
you can set the `REALM_HOSTS` setting in `/etc/zulip/settings.py` to a
Python dictionary, like this:
```
REALM_HOSTS = {
'mysubdomain': 'hostname.example.com',
}
```
What this will do is map the hostname `hostname.example.com` to the
realm whose `subdomain` in the Zulip database is `mysubdomain`.
In a future version of Zulip, we expect to move this configuration
into the database.
### The root domain ### The root domain
Most Zulip servers host a single Zulip organization on the root domain Most Zulip servers host a single Zulip organization on the root domain