mirror of https://github.com/zulip/zulip.git
help: Improve and extend "Export your oganization" documentation.
- Document compliance exports. - Make structure of all the sections consistent. - Make other tweaks to improve clarity. Co-authored-by: Alya Abbott <alya@zulip.com>
This commit is contained in:
Alex Vandiver
Tim Abbott
parent
dbc2b2a839
commit
95bdfa8ff8
|
|
@ -7,23 +7,38 @@
|
||||||
documentation on [server export and import][export-and-import] or
|
documentation on [server export and import][export-and-import] or
|
||||||
[server backups][production-backups].
|
[server backups][production-backups].
|
||||||
|
|
||||||
Zulip has high quality export tools that can be used to migrate from the
|
Zulip has high quality export tools that can be used to migrate from the hosted
|
||||||
hosted Zulip Cloud service (zulip.com) to your own servers. There are
|
Zulip Cloud service to your own servers. Two types of data exports are available
|
||||||
three types of Zulip Cloud exports.
|
to all Zulip Cloud organizations:
|
||||||
|
|
||||||
* **Export of public data**: An export of all users, settings, and all the data that
|
* [**Export of public data**](#export-of-public-data): Complete data for your
|
||||||
appears in public streams.
|
organization *other than* [private stream](/help/stream-permissions) messages
|
||||||
* **Full export with member consent**: Everything in export of public data, plus all
|
and [direct messages](/help/direct-messages).
|
||||||
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
|
* [**Full export with member consent**](#full-export-with-member-consent):
|
||||||
Zulip Cloud Standard customers have access to **full export without member consent**.
|
Everything in the export of public data, plus all the [private
|
||||||
|
stream](/help/stream-permissions) messages and [direct
|
||||||
|
messages](/help/direct-messages) of members who opt in to have their data
|
||||||
|
exported.
|
||||||
|
|
||||||
|
Two additional types of data exports are available to **corporate** [Zulip Cloud
|
||||||
|
Standard][standard] customers:
|
||||||
|
|
||||||
|
[standard]: https://zulip.com/plans/
|
||||||
|
|
||||||
|
* [**Full export without member consent**](#full-export-without-member-consent):
|
||||||
|
All the data in the organization.
|
||||||
|
|
||||||
|
* [**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 of public data
|
## Export of public data
|
||||||
|
|
||||||
{!admin-only.md!}
|
{!admin-only.md!}
|
||||||
|
|
||||||
|
{!not-human-export-format.md!}
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
{settings_tab|data-exports-admin}
|
{settings_tab|data-exports-admin}
|
||||||
|
|
@ -35,64 +50,122 @@ file from that page.
|
||||||
|
|
||||||
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
||||||
|
|
||||||
{end_tabs}
|
!!! warn ""
|
||||||
|
|
||||||
Note that generating the export can take up to an hour for organizations
|
Generating the export can take up to an hour for organizations
|
||||||
with lots of messages or uploaded files.
|
with a large number of messages or uploaded files.
|
||||||
|
|
||||||
|
{end_tabs}
|
||||||
|
|
||||||
## Full export with member consent
|
## Full export with member consent
|
||||||
|
|
||||||
{!owner-only.md!}
|
{!owner-only.md!}
|
||||||
|
|
||||||
|
{!not-human-export-format.md!}
|
||||||
|
|
||||||
|
In addition to your organization's public data, this export includes all the
|
||||||
|
messages received by any user in the organization who consents to the data
|
||||||
|
export. In particular, it includes any [private
|
||||||
|
stream](/help/stream-permissions) messages and [direct
|
||||||
|
messages](/help/direct-messages) where *at least one of the recipients* has
|
||||||
|
given consent.
|
||||||
|
|
||||||
|
Users who do not provide consent will have their settings and stream
|
||||||
|
subscriptions exported, but will have no personalized message history.
|
||||||
|
|
||||||
{start_tabs}
|
{start_tabs}
|
||||||
|
|
||||||
1. Email support@zulip.com with your organization's zulip.com URL, asking for
|
1. Email [support@zulip.com](mailto:support@zulip.com) with your
|
||||||
a full export with member consent. Email us from the same address that
|
organization's `zulipchat.com` URL, asking for a **full export with
|
||||||
you use to sign in to Zulip.
|
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.
|
||||||
|
|
||||||
1. We will verify that you are an organization administrator, and email you
|
1. You will receive an email with instructions on how to collect member consent.
|
||||||
instructions on how to collect member consent.
|
Follow the instructions, and notify
|
||||||
|
[support@zulip.com](mailto:support@zulip.com) when the process has been
|
||||||
|
completed.
|
||||||
|
|
||||||
1. The end result of that process with be an archive in the same
|
1. You will receive an archive in the `.tar.gz` format containing all public
|
||||||
format as the exports of public data discussed above, including extra
|
information for your organization, plus [private
|
||||||
private stream and direct message data for users who gave consent.
|
stream](/help/stream-permissions) messages and [direct
|
||||||
|
messages](/help/direct-messages) for users who gave consent.
|
||||||
|
|
||||||
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
||||||
|
|
||||||
{end_tabs}
|
{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 direct
|
|
||||||
message content where at least one of the participants gives consent.
|
|
||||||
|
|
||||||
Users who do not provide consent will have their settings and stream
|
|
||||||
subscriptions exported, but will otherwise be treated as new users after
|
|
||||||
import.
|
|
||||||
|
|
||||||
## Full export without member consent
|
## Full export without member consent
|
||||||
|
|
||||||
{!owner-only.md!}
|
{!owner-only.md!}
|
||||||
|
|
||||||
This export is limited to paid Zulip Cloud Standard customers, though in rare
|
{!not-human-export-format.md!}
|
||||||
cases may be available to other organizations in case of due legal process.
|
|
||||||
|
|
||||||
To start this export, email support@zulip.com with your zulip.com
|
{!export-without-consent-requirements.md!}
|
||||||
URL, asking for a full export without member consent.
|
|
||||||
|
|
||||||
You'll also need to email us evidence that you have authority to read
|
{start_tabs}
|
||||||
members' direct messages. Typically, this will be because the zulip.com
|
|
||||||
URL is administered by a corporation, and you are an official
|
1. Email [support@zulip.com](mailto:support@zulip.com) with your
|
||||||
representative of that corporation. By requesting and approving this export,
|
organization's `zulipchat.com` URL, asking for a **full export without
|
||||||
you will also assume full legal responsibility that the appropriate employment
|
member consent**. Please send the email from the same address
|
||||||
agreements and corporate policy for this type of export are in place. Note
|
that you use to sign in to Zulip, so that Zulip Support can verify
|
||||||
that many countries have laws that require employers to notify employees of
|
that you are an owner of the organization.
|
||||||
their use of such an export.
|
|
||||||
|
1. 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.
|
||||||
|
|
||||||
|
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
||||||
|
|
||||||
|
{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](mailto: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.
|
||||||
|
|
||||||
|
1. You will receive the requested information once your authority to request the
|
||||||
|
export has been verified.
|
||||||
|
|
||||||
|
{end_tabs}
|
||||||
|
|
||||||
## Related articles
|
## Related articles
|
||||||
|
|
||||||
* [Import into an on-premises installation][import-only]
|
* [Change organization URL](/help/change-organization-url)
|
||||||
|
* [Deactivate your organization](/help/deactivate-your-organization)
|
||||||
|
* [Import organization into a self-hosted Zulip server][import-only]
|
||||||
|
* [Compliance exports for self-hosted organizations][compliance-exports-self-hosted]
|
||||||
|
|
||||||
[production-backups]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups
|
[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#data-export
|
[export-and-import]: https://zulip.readthedocs.io/en/stable/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
|
[import-only]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#import-into-a-new-zulip-server
|
||||||
|
[compliance-exports-self-hosted]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#compliance-exports
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,13 @@
|
||||||
|
To perform this export, your organization must meet the following requirements:
|
||||||
|
|
||||||
|
- You are a paid [Zulip Cloud Standard][standard] customer. In rare cases,
|
||||||
|
exceptions may be made in case of due legal process.
|
||||||
|
|
||||||
|
- You have authority to read members' [direct messages](/help/direct-messages).
|
||||||
|
Typically, this will be because your Zulip organization is administered by a
|
||||||
|
corporation, and you are an official representative of that corporation.
|
||||||
|
|
||||||
|
By requesting and approving this export, you will 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.
|
||||||
|
|
@ -0,0 +1,4 @@
|
||||||
|
!!! warn ""
|
||||||
|
|
||||||
|
The format of this export is designed for importing into a self-hosted
|
||||||
|
installation of Zulip. It is not designed to be human-readable.
|
||||||
Loading…
Reference in New Issue