Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

docs: Improve documentation for changing a realm's subdomain. 

The current documentation doesn't clearly explain the process of
changing the organization's subdomain.
This commit adds instructions for user to get the string_id of their
organization and then lists the commands to be executed in the
management shell to change the subdomain.

Part of #17857.
This commit is contained in:
Siddharth Asthana 2021-03-29 14:08:58 +05:30 committed by Tim Abbott
parent c75b7e851a
commit e7f24ac8d4
1 changed files with 19 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
templates/zerver/help/change-organization-url.md
View File

@ -21,13 +21,26 @@ for paid plans.
## Self-hosting
If you're self-hosting, you can change the root domain of your server
by changing the `EXTERNAL_HOST` [setting][zulip-settings]. If you're
[hosting multiple organizations][zulip-multiple-organizations] and
want to change the subdomain for one of them, you can use
`do_change_realm_subdomain(realm, "new_subdomain")` in a [management
shell][management-shell].
If you're self-hosting, you can change the root domain of your Zulip
server by changing the `EXTERNAL_HOST` [setting][zulip-settings]. If
you're [hosting multiple organizations][zulip-multiple-organizations]
and want to change the subdomain for one of them, you can follow these
steps:
{start_tabs}
1. Get the `string_id` for your organization as [described here][find-string-id]
2. Run the following commands in a [management shell][management-shell]:
```
realm = get_realm("string_id")
do_change_realm_subdomain(realm, "new_subdomain")
```
{end_tabs}
[zulip-settings]: https://zulip.readthedocs.io/en/stable/production/settings.html
[zulip-multiple-organizations]: https://zulip.readthedocs.io/en/stable/production/multiple-organizations.html
[management-shell]: https://zulip.readthedocs.io/en/stable/production/management-commands.html#manage-py-shell
[find-string-id]: https://zulip.readthedocs.io/en/stable/production/management-commands.html#accessing-an-organization-s-string-id