ContextQMD
Back to Zulip

Export your organization

starlight_help/src/content/docs/export-your-organization.mdx

12.06.0 KB
Original Source

import {Steps, TabItem, Tabs} from "@astrojs/starlight/components";

import FlattenedSteps from "../../components/FlattenedSteps.astro"; import NavigationSteps from "../../components/NavigationSteps.astro"; import ZulipNote from "../../components/ZulipNote.astro"; import AdminOnly from "../include/_AdminOnly.mdx"; import ExportAllPublicAndPrivateDataRequirements from "../include/_ExportAllPublicAndPrivateDataRequirements.mdx"; import NotHumanExportFormat from "../include/_NotHumanExportFormat.mdx"; import OwnerOnly from "../include/_OwnerOnly.mdx";

<ZulipNote> 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]. </ZulipNote>

Zulip has high quality export tools that can be used to migrate between the hosted Zulip Cloud service and your own servers. Zulip offers the following options for exporting data in an importable format:

In addition, Zulip Cloud Standard and Zulip Cloud Plus customers can request a compliance export:

  • Compliance export: A targeted, human-readable export of messages matching some combination of criteria (e.g., sender, recipient, message keyword, or timestamp).

Export data in an importable format

<AdminOnly /> <NotHumanExportFormat /> <Tabs> <TabItem label="Desktop/Web"> <FlattenedSteps> <NavigationSteps target="settings/data-exports-admin" /> 
  1. Click **Start export**.
  1. Select the desired **Export type**.
  1. 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.
  1. Use [Zulip's logical data import tool][import-only] to import your data into
     a self-hosted server. For Zulip Cloud imports, contact
     [[email protected]](mailto:[email protected]).
</FlattenedSteps>

<ZulipNote>
  Generating the export can take up to an hour for organizations
  with a large number of messages or uploaded files.
</ZulipNote>
</TabItem> </Tabs>

Export of all public and private data

<OwnerOnly /> <ExportAllPublicAndPrivateDataRequirements />

Contact [email protected] to request access to this export type, then follow the export instructions above.

If you self-host Zulip, an export of all public and private data can be performed by your server's administrator.

Compliance export

<OwnerOnly />

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.

<ExportAllPublicAndPrivateDataRequirements /> <Steps> 1. Email [[email protected]](mailto:[email protected]) 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 1. 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. 1. Your preferred format for the export: CSV or JSON. 1. Whether or not you want to receive copies of all attachments referenced in the exported messages. 1. You will receive the requested information once your authority to request the export has been verified. </Steps>

If you self-host Zulip, a compliance export can be performed by your server's administrator.

Configure whether administrators can export your private data

<FlattenedSteps> <NavigationSteps target="settings/account-and-privacy" />
  1. Under Privacy, toggle Let administrators export my private data. </FlattenedSteps>