From 828104e020991e889713e69b6e71f2e16e548e1c Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Wed, 16 May 2018 07:02:13 -0700 Subject: [PATCH] docs: Document the REALM_HOSTS feature. --- docs/production/multiple-organizations.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/docs/production/multiple-organizations.md b/docs/production/multiple-organizations.md index 41ec1a965f..94e82aa843 100644 --- a/docs/production/multiple-organizations.md +++ b/docs/production/multiple-organizations.md @@ -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 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 Most Zulip servers host a single Zulip organization on the root domain