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

help: Document process for changing organization URL.

This commit is contained in:
Tim Abbott 2020-07-24 16:07:53 -07:00
parent 2922e2cbb1
commit ec9c272165
3 changed files with 32 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
templates/zerver/help/change-organization-url.md Normal file
View File

@ -0,0 +1,30 @@
# Change organization URL
Zulip supports changing the URL for an organization. Changing the
organization URL is a disruptive operation for users:
* Users will be logged out of existing sessions on the web, mobile and
desktop apps and need to login again.
* Any [API clients](/api) or [integrations](/integrations) will need
to be updated to point to the new organization URL.
We recommend using a [wildcard
mention](/help/mention-a-user-or-group#mention-everyone-on-a-stream)
in an announcement stream to notify users that they need to update
their clients.
If you're using Zulip Cloud (E.g. `https://example.zulipchat.com`),
you can request a change by emailing support@zulip.com.
## Self-hosting
If you're self-hosting, you can change the root domain if 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_realm_change_subdomain(realm, "new_subdomain")` in a [management
shell][management-shell].
[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

1
templates/zerver/help/include/sidebar_index.md
View File

@ -113,6 +113,7 @@
* [Roles and permissions](/help/roles-and-permissions) * [Roles and permissions](/help/roles-and-permissions)
* [Set the default language for new users](/help/change-the-default-language-for-your-organization) * [Set the default language for new users](/help/change-the-default-language-for-your-organization)
* [Export your organization](/help/export-your-organization) * [Export your organization](/help/export-your-organization)
* [Change organization URL](/help/change-organization-url)
* [Deactivate your organization](/help/deactivate-your-organization) * [Deactivate your organization](/help/deactivate-your-organization)
* [GDPR Compliance](/help/gdpr-compliance) * [GDPR Compliance](/help/gdpr-compliance)

1
tools/linter_lib/custom_check.py
View File

@ -717,6 +717,7 @@ help_markdown_rules = RuleList(
}, },
{'pattern': r'\b[rR]ealm[s]?\b', {'pattern': r'\b[rR]ealm[s]?\b',
'include_only': {'templates/zerver/help/'}, 'include_only': {'templates/zerver/help/'},
'exclude': {'templates/zerver/help/change-organization-url.md'},
'good_lines': ['Organization', 'deactivate_realm', 'realm_filter'], 'good_lines': ['Organization', 'deactivate_realm', 'realm_filter'],
'bad_lines': ['Users are in a realm', 'Realm is the best model'], 'bad_lines': ['Users are in a realm', 'Realm is the best model'],
'description': "Realms are referred to as Organizations in user-facing docs."}, 'description': "Realms are referred to as Organizations in user-facing docs."},