2018-07-26 00:09:58 +02:00
|
|
|
# Export your organization
|
|
|
|
|
|
|
|
!!! warn ""
|
2020-06-09 00:58:42 +02:00
|
|
|
These instructions are specific to the hosted Zulip Cloud service.
|
2018-07-26 00:09:58 +02:00
|
|
|
If you're running your own server, you may be looking for our
|
|
|
|
documentation on [server export and import][export-and-import] or
|
|
|
|
[server backups][production-backups].
|
|
|
|
|
|
|
|
Zulip has high quality export tools that can be used to migrate from the
|
2020-06-09 00:58:42 +02:00
|
|
|
hosted Zulip Cloud service (zulip.com) to your own servers. There are
|
|
|
|
three types of Zulip Cloud exports.
|
2018-07-26 00:09:58 +02:00
|
|
|
|
|
|
|
* **Public export**: An export of all users, settings, and all the data that
|
|
|
|
appears in public streams.
|
|
|
|
* **Full export with member consent**: Everything in public export, plus all
|
|
|
|
the private data of members that opt-in to the export.
|
|
|
|
* **Full export without member consent**: All the data in the organization.
|
|
|
|
|
|
|
|
All organizations have access to the first two kinds of export. Only corporate
|
2018-10-24 06:09:01 +02:00
|
|
|
Zulip Standard customers have access to **full export without member consent**.
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
## Public export
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2020-06-10 22:42:20 +02:00
|
|
|
{!admin-only.md!}
|
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
{start_tabs}
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
{settings_tab|data-exports-admin}
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
1. Click **Start public export**.
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
1. After a few minutes, you'll be able to download the export as a `.tar.gz`
|
|
|
|
file from that page.
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2020-03-30 22:23:21 +02:00
|
|
|
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
{end_tabs}
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
Note that generating the export can take up to an hour for organizations
|
|
|
|
with lots of messages or uploaded files.
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
## Full export with member consent
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2020-06-10 22:42:20 +02:00
|
|
|
{!owner-only.md!}
|
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
{start_tabs}
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2020-06-09 00:58:42 +02:00
|
|
|
1. Email support@zulip.com with your organization's zulip.com URL, asking for
|
2019-08-14 22:43:00 +02:00
|
|
|
a full export with member consent. Email us from the same address that
|
|
|
|
you use to sign in to Zulip.
|
|
|
|
|
|
|
|
1. We will verify that you are an organization administrator, and email you
|
|
|
|
instructions on how to collect member consent.
|
|
|
|
|
2020-03-30 22:23:21 +02:00
|
|
|
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].
|
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
{end_tabs}
|
|
|
|
|
|
|
|
Note that such an export will include all the messages received by any user
|
|
|
|
in the organization that consents to the data export. In particular, it
|
|
|
|
will include all public stream content and any private stream or private
|
|
|
|
message content where at least one of the participants gives consent.
|
2019-05-16 01:52:42 +02:00
|
|
|
|
|
|
|
Users who do not provide consent will have their settings and stream
|
|
|
|
subscriptions exported, but will otherwise be treated as new users after
|
|
|
|
import.
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
## Full export without member consent
|
|
|
|
|
2020-06-10 22:42:20 +02:00
|
|
|
{!owner-only.md!}
|
|
|
|
|
2019-08-14 22:43:00 +02:00
|
|
|
This export is limited to paid Zulip Standard customers, though in rare
|
|
|
|
cases may be available to other organizations in case of due legal process.
|
|
|
|
|
2020-06-09 00:58:42 +02:00
|
|
|
To start this export, email support@zulip.com with your zulip.com
|
|
|
|
URL, asking for a full export without member consent.
|
2019-08-14 22:43:00 +02:00
|
|
|
|
|
|
|
You'll also need to email us evidence that you have authority to read
|
2020-06-09 00:58:42 +02:00
|
|
|
members' private messages. Typically, this will be because the zulip.com
|
|
|
|
URL is administered by a corporation, and you are an official
|
2019-08-14 22:43:00 +02:00
|
|
|
representative of that corporation. By requesting and approving this export,
|
|
|
|
you will also assume full legal responsibility that the appropriate employment
|
|
|
|
agreements and corporate policy for this type of export are in place. Note
|
|
|
|
that many countries have laws that require employers to notify employees of
|
|
|
|
their use of such an export.
|
2018-07-26 00:09:58 +02:00
|
|
|
|
|
|
|
## Related articles
|
|
|
|
|
2019-04-26 03:05:17 +02:00
|
|
|
* [Import into an on-premises installation][import-only]
|
2018-07-26 00:09:58 +02:00
|
|
|
|
2019-09-25 01:58:20 +02:00
|
|
|
[production-backups]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups
|
2020-03-30 22:23:21 +02:00
|
|
|
[export-and-import]: https://zulip.readthedocs.io/en/latest/production/export-and-import.html#data-export
|
2019-04-26 03:05:17 +02:00
|
|
|
[import-only]: https://zulip.readthedocs.io/en/latest/production/export-and-import.html#import-into-a-new-zulip-server
|