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. 

Add a single line for self-hosting case to point to the ReadTheDocs
section of management command to change the realm's subdomain.

Fixes: #17857
This commit is contained in:
Siddharth Asthana 2021-05-10 23:57:13 +05:30 committed by Tim Abbott
parent 8f864c5107
commit 6ee7d5c983
2 changed files with 4 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/production/management-commands.md
View File

@ -116,6 +116,7 @@ There are dozens of useful management commands under
users.
* `./manage.py send_password_reset_email`: Sends password reset email(s)
to one or more users.
* `./manage.py change_realm_subdomain`: Change subdomain of a realm.
* `./manage.py change_user_email`: Change a user's email address.
* `./manage.py change_user_role`: Can change are user's role
(easier done [via the

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

@ -24,23 +24,9 @@ for paid plans.
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}
and want to change the subdomain for one of them, you can do this
using the `change_realm_subdomain` [management command][management-commands].
[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
[management-commands]: https://zulip.readthedocs.io/en/latest/production/management-commands.html#other-useful-manage-py-commands