zulip/help/export-your-organization.md

5.2 KiB

Export your organization

!!! warn ""

If you're self-hosting Zulip, you may want to check out the
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 between the hosted Zulip Cloud service and your own servers. Two types of data exports are available for all Zulip organizations:

Two additional types of data exports are available to corporate Zulip Cloud Standard and Zulip Cloud Plus customers:

Export for migrating to Zulip Cloud or a self-hosted server

{!admin-only.md!}

{!not-human-export-format.md!}

{start_tabs}

{settings_tab|data-exports-admin}

  1. Click Start export.

  2. Select the desired Export type.

  3. Click Start export to begin the export process. After a few minutes, you'll be able to download the exported data from the list of data exports.

  4. Use Zulip's logical data import tool to import your data into a self-hosted server. For Zulip Cloud imports, contact support@zulip.com.

!!! warn ""

Generating the export can take up to an hour for organizations
with a large number of messages or uploaded files.

{end_tabs}

{!owner-only.md!}

{!not-human-export-format.md!}

{!export-without-consent-requirements.md!}

{start_tabs}

  1. Email support@zulip.com with your organization's zulipchat.com URL, asking for a full export without member consent. Please send the email from the same address that you use to sign in to Zulip, so that Zulip Support can verify that you are an owner of the organization.

  2. Once your authority to request the export has been verified, you will receive an archive in the .tar.gz format containing all the information for your organization.

  3. Import the tarball using Zulip's logical data import tool.

{end_tabs}

Compliance export

{!owner-only.md!}

This type of export is recommended if you plan to work with the exported data directly (e.g., reading messages or processing them with a script), rather than importing the export into a new Zulip organization.

{!export-without-consent-requirements.md!}

{start_tabs}

  1. Email support@zulip.com asking for a compliance export. Please send the email from the same address that you use to sign in to Zulip, so that Zulip Support can verify that you are an owner of the organization. You will need to specify:

    1. The zulipchat.com URL for your organization

    2. What limits you would like on the export. Currently, compliance exports can apply any combination of the following filters:

      • Message sender
      • Message recipient
      • Message contents, by specific keywords
      • Sent timestamp before, after, or between dates

      If you need other limits, please ask.

    3. Your preferred format for the export: CSV or JSON.

    4. Whether or not you want to receive copies of all attachments referenced in the exported messages.

  2. You will receive the requested information once your authority to request the export has been verified.

{end_tabs}

Configure whether administrators can export your private data

{start_tabs}

{settings_tab|account-and-privacy}

  1. Under Privacy, toggle Let administrators export my private data.

{end_tabs}