From 724fcc74e8c33f05eb756c62957389b1bc6e8cae Mon Sep 17 00:00:00 2001 From: Tim Abbott Date: Mon, 30 Mar 2020 13:23:21 -0700 Subject: [PATCH] help: Improve documentation on importing exported organizations. This should help avoid confusion where some users used the Zulip backup tool, not the import tool, to try to import their backups. --- docs/production/export-and-import.md | 6 +++--- templates/zerver/help/export-your-organization.md | 10 +++++++++- 2 files changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/production/export-and-import.md b/docs/production/export-and-import.md index 7cbfb12dde..9c47ab612b 100644 --- a/docs/production/export-and-import.md +++ b/docs/production/export-and-import.md @@ -301,7 +301,9 @@ archive of all the organization's uploaded files. * Ensure that the Zulip server you're importing into is running the same version of Zulip as the server you're exporting from. - * For exports from zulipchat.com, run the following: + * For exports from zulipchat.com, you need to [upgrade to + master][upgrade-zulip-from-git], since we run run master on + zulipchat.com: ``` /home/zulip/deployments/current/scripts/upgrade-zulip-from-git master @@ -311,8 +313,6 @@ archive of all the organization's uploaded files. zulipchat.com runs pre-release versions of Zulip that are often several months of development ahead of the latest release. - Read the instructions [here][upgrade-zulip-from-git] for more details. - * Note that if your server has limited free RAM, you'll want to shut down the Zulip server with `supervisorctl stop all` while you run the import, since our minimal system requirements do not diff --git a/templates/zerver/help/export-your-organization.md b/templates/zerver/help/export-your-organization.md index e86d924c6f..5cbb7fb474 100644 --- a/templates/zerver/help/export-your-organization.md +++ b/templates/zerver/help/export-your-organization.md @@ -32,6 +32,8 @@ Zulip Standard customers have access to **full export without member consent**. 1. After a few minutes, you'll be able to download the export as a `.tar.gz` file from that page. +1. Import the tarball using [Zulip's logical data import tool][import-only]. + {end_tabs} Note that generating the export can take up to an hour for organizations @@ -48,6 +50,12 @@ with lots of messages or uploaded files. 1. We will verify that you are an organization administrator, and email you instructions on how to collect member consent. +1. The end result of that process with be an archive in the same + format as the public exports discussed above, including extra + private stream and private message data for users who gave consent. + +1. Import the tarball using [Zulip's logical data import tool][import-only]. + {end_tabs} Note that such an export will include all the messages received by any user @@ -81,5 +89,5 @@ their use of such an export. * [Import into an on-premises installation][import-only] [production-backups]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups -[export-and-import]: https://zulip.readthedocs.io/en/latest/production/export-and-import.html +[export-and-import]: https://zulip.readthedocs.io/en/latest/production/export-and-import.html#data-export [import-only]: https://zulip.readthedocs.io/en/latest/production/export-and-import.html#import-into-a-new-zulip-server