mirror of https://github.com/zulip/zulip.git
help: Update exports documentation.
Document in-app exports with user consent.
This commit is contained in:
parent
efc6c70d3b
commit
b8dd409d71
|
@ -79,11 +79,12 @@ format used by the Zulip server that they are interacting with.
|
||||||
* [`GET /export/realm`](/api/get-realm-exports),
|
* [`GET /export/realm`](/api/get-realm-exports),
|
||||||
[`GET /events`](/api/get-events): Added `export_type` field
|
[`GET /events`](/api/get-events): Added `export_type` field
|
||||||
to the dictionaries in `exports` array. It indicates whether
|
to the dictionaries in `exports` array. It indicates whether
|
||||||
the export is of public data or full data with user consent.
|
the export is of public data or full data with user consent
|
||||||
|
(standard export).
|
||||||
|
|
||||||
* [`POST /export/realm`](/api/get-realm-exports): Added `export_type`
|
* [`POST /export/realm`](/api/get-realm-exports): Added `export_type`
|
||||||
parameter to add support for admins to decide whether to create a
|
parameter to add support for admins to decide whether to create a
|
||||||
public data export or a full data export with member consent.
|
public or a standard data export.
|
||||||
|
|
||||||
**Feature level 303**
|
**Feature level 303**
|
||||||
|
|
||||||
|
@ -185,8 +186,8 @@ format used by the Zulip server that they are interacting with.
|
||||||
**Feature level 295**
|
**Feature level 295**
|
||||||
|
|
||||||
* [`GET /export/realm/consents`](/api/get-realm-export-consents): Added
|
* [`GET /export/realm/consents`](/api/get-realm-export-consents): Added
|
||||||
a new endpoint to fetch the consents of users for their [private data
|
a new endpoint to fetch the [consents of users](/help/export-your-organization#configure-whether-administrators-can-export-your-private-data)
|
||||||
exports](/help/export-your-organization#full-export-with-member-consent).
|
for their private data exports.
|
||||||
* `/api/v1/tus` is an endpoint implementing the [`tus`
|
* `/api/v1/tus` is an endpoint implementing the [`tus`
|
||||||
protocol](https://tus.io/protocols/resumable-upload) for resumable uploads.
|
protocol](https://tus.io/protocols/resumable-upload) for resumable uploads.
|
||||||
Clients which send authenticated credentials (either via browser-based
|
Clients which send authenticated credentials (either via browser-based
|
||||||
|
|
|
@ -1405,9 +1405,8 @@ _Released 2022-07-21_
|
||||||
_Released 2022-07-11_
|
_Released 2022-07-11_
|
||||||
|
|
||||||
- CVE-2022-31134: Exclude private file uploads from [exports of public
|
- CVE-2022-31134: Exclude private file uploads from [exports of public
|
||||||
data](https://zulip.com/help/export-your-organization#export-of-public-data). We
|
data](https://zulip.com/help/export-your-organization#export-for-migrating-to-zulip-cloud-or-a-self-hosted-server).
|
||||||
would like to thank Antoine Benoist for bringing this issue to our
|
We would like to thank Antoine Benoist for bringing this issue to our attention.
|
||||||
attention.
|
|
||||||
- Upgraded python requirements.
|
- Upgraded python requirements.
|
||||||
- Improved documentation for load balancers to mention CIDR address
|
- Improved documentation for load balancers to mention CIDR address
|
||||||
ranges.
|
ranges.
|
||||||
|
|
|
@ -2,24 +2,28 @@
|
||||||
|
|
||||||
!!! warn ""
|
!!! warn ""
|
||||||
|
|
||||||
These instructions are specific to the hosted Zulip Cloud service.
|
If you're self-hosting Zulip, you may want to check out the
|
||||||
If you're running your own server, you may be looking for our
|
|
||||||
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 hosted
|
Zulip has high quality export tools that can be used to migrate between the
|
||||||
Zulip Cloud service to your own servers. Two types of data exports are available
|
hosted Zulip Cloud service and your own servers. Two types of data exports are
|
||||||
to all Zulip Cloud organizations:
|
available for all Zulip organizations:
|
||||||
|
|
||||||
* [**Export of public data**](#export-of-public-data): Complete data for your
|
* [**Export of public
|
||||||
organization *other than* [private channel](/help/channel-permissions) messages
|
data**](#export-for-migrating-to-zulip-cloud-or-a-self-hosted-server):
|
||||||
and [direct messages](/help/direct-messages).
|
Complete data for your organization *other than* [private
|
||||||
|
channel](/help/channel-permissions) messages and [direct
|
||||||
|
messages](/help/direct-messages). This export includes user settings and
|
||||||
|
channel subscriptions.
|
||||||
|
|
||||||
* [**Full export with member consent**](#full-export-with-member-consent):
|
* [**Standard
|
||||||
|
export**](#export-for-migrating-to-zulip-cloud-or-a-self-hosted-server):
|
||||||
Everything in the export of public data, plus all the [private
|
Everything in the export of public data, plus all the [private
|
||||||
channel](/help/channel-permissions) messages and [direct
|
channel](/help/channel-permissions) messages and [direct
|
||||||
messages](/help/direct-messages) of members who opt in to have their data
|
messages](/help/direct-messages) that members who have
|
||||||
exported.
|
[allowed](#configure-whether-administrators-can-export-your-private-data)
|
||||||
|
administrators to export their private data can access.
|
||||||
|
|
||||||
Two additional types of data exports are available to **corporate** [Zulip Cloud
|
Two additional types of data exports are available to **corporate** [Zulip Cloud
|
||||||
Standard][plans] and [Zulip Cloud Plus][plans] customers:
|
Standard][plans] and [Zulip Cloud Plus][plans] customers:
|
||||||
|
@ -33,7 +37,7 @@ Standard][plans] and [Zulip Cloud Plus][plans] customers:
|
||||||
of messages matching some combination of criteria (e.g., sender, recipient,
|
of messages matching some combination of criteria (e.g., sender, recipient,
|
||||||
message keyword, or timestamp).
|
message keyword, or timestamp).
|
||||||
|
|
||||||
## Export of public data
|
## Export for migrating to Zulip Cloud or a self-hosted server
|
||||||
|
|
||||||
{!admin-only.md!}
|
{!admin-only.md!}
|
||||||
|
|
||||||
|
@ -43,12 +47,17 @@ Standard][plans] and [Zulip Cloud Plus][plans] customers:
|
||||||
|
|
||||||
{settings_tab|data-exports-admin}
|
{settings_tab|data-exports-admin}
|
||||||
|
|
||||||
1. Click **Start export of public data**.
|
1. Click **Start export**.
|
||||||
|
|
||||||
1. After a few minutes, you'll be able to download the export as a `.tar.gz`
|
1. Select the desired **Export type**.
|
||||||
file from that page.
|
|
||||||
|
|
||||||
1. Import the tarball using [Zulip's logical data import tool][import-only].
|
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
|
||||||
|
[support@zulip.com](mailto:support@zulip.com).
|
||||||
|
|
||||||
!!! warn ""
|
!!! warn ""
|
||||||
|
|
||||||
|
@ -57,44 +66,6 @@ file from that page.
|
||||||
|
|
||||||
{end_tabs}
|
{end_tabs}
|
||||||
|
|
||||||
## Full export with member consent
|
|
||||||
|
|
||||||
{!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
|
|
||||||
channel](/help/channel-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 channel
|
|
||||||
subscriptions exported, but will have no personalized message history.
|
|
||||||
|
|
||||||
{start_tabs}
|
|
||||||
|
|
||||||
1. Email [support@zulip.com](mailto:support@zulip.com) with your
|
|
||||||
organization's `zulipchat.com` URL, asking for a **full export with
|
|
||||||
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. You will receive an email with 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. You will receive an archive in the `.tar.gz` format containing all public
|
|
||||||
information for your organization, plus [private
|
|
||||||
channel](/help/channel-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].
|
|
||||||
|
|
||||||
{end_tabs}
|
|
||||||
|
|
||||||
## Full export without member consent
|
## Full export without member consent
|
||||||
|
|
||||||
{!owner-only.md!}
|
{!owner-only.md!}
|
||||||
|
@ -158,6 +129,16 @@ importing the export into a new Zulip organization.
|
||||||
|
|
||||||
{end_tabs}
|
{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}
|
||||||
|
|
||||||
## Related articles
|
## Related articles
|
||||||
|
|
||||||
* [Change organization URL](/help/change-organization-url)
|
* [Change organization URL](/help/change-organization-url)
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
!!! warn ""
|
!!! warn ""
|
||||||
|
|
||||||
The format of this export is designed for importing into a self-hosted
|
This export is formatted for importing into Zulip Cloud or a self-hosted
|
||||||
installation of Zulip. It is not designed to be human-readable.
|
installation of Zulip. It is not designed to be human-readable.
|
||||||
|
|
|
@ -98,7 +98,7 @@
|
||||||
setting_name="allow_private_data_export"
|
setting_name="allow_private_data_export"
|
||||||
is_checked=settings_object.allow_private_data_export
|
is_checked=settings_object.allow_private_data_export
|
||||||
label=settings_label.allow_private_data_export
|
label=settings_label.allow_private_data_export
|
||||||
help_link="/help/export-your-organization#full-export-with-member-consent"
|
help_link="/help/export-your-organization#export-your-organization"
|
||||||
}}
|
}}
|
||||||
</div>
|
</div>
|
||||||
<div class="input-group">
|
<div class="input-group">
|
||||||
|
|
|
@ -13119,16 +13119,15 @@ paths:
|
||||||
tags: ["server_and_organizations"]
|
tags: ["server_and_organizations"]
|
||||||
x-requires-administrator: true
|
x-requires-administrator: true
|
||||||
description: |
|
description: |
|
||||||
Fetch all [public data exports][public-data-export] and
|
Fetch all the public and standard [data exports][export-data]
|
||||||
[full data exports with member consent][full-data-export] of the organization.
|
of the organization.
|
||||||
|
|
||||||
**Changes**: Prior to Zulip 10.0 (feature level 304), only
|
**Changes**: Prior to Zulip 10.0 (feature level 304), only
|
||||||
public data exports could be fetched using this endpoint.
|
public data exports could be fetched using this endpoint.
|
||||||
|
|
||||||
New in Zulip 2.1.
|
New in Zulip 2.1.
|
||||||
|
|
||||||
[public-data-export]: /help/export-your-organization#export-of-public-data
|
[export-data]: /help/export-your-organization#export-for-migrating-to-zulip-cloud-or-a-self-hosted-server
|
||||||
[full-data-export]: /help/export-your-organization#full-export-with-member-consent
|
|
||||||
responses:
|
responses:
|
||||||
"200":
|
"200":
|
||||||
description: Success.
|
description: Success.
|
||||||
|
@ -13173,8 +13172,7 @@ paths:
|
||||||
tags: ["server_and_organizations"]
|
tags: ["server_and_organizations"]
|
||||||
x-requires-administrator: true
|
x-requires-administrator: true
|
||||||
description: |
|
description: |
|
||||||
Create a [public data export][public-data-export] or a
|
Create a public or a standard [data export][export-data] of the organization.
|
||||||
[full data export with member consent][full-data-export] of the organization.
|
|
||||||
|
|
||||||
!!! warn ""
|
!!! warn ""
|
||||||
|
|
||||||
|
@ -13187,8 +13185,7 @@ paths:
|
||||||
|
|
||||||
New in Zulip 2.1.
|
New in Zulip 2.1.
|
||||||
|
|
||||||
[public-data-export]: /help/export-your-organization#export-of-public-data
|
[export-data]: /help/export-your-organization#export-for-migrating-to-zulip-cloud-or-a-self-hosted-server
|
||||||
[full-data-export]: /help/export-your-organization#full-export-with-member-consent
|
|
||||||
[data-export]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#data-export
|
[data-export]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#data-export
|
||||||
[backups]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups
|
[backups]: https://zulip.readthedocs.io/en/stable/production/export-and-import.html#backups
|
||||||
requestBody:
|
requestBody:
|
||||||
|
@ -13200,10 +13197,10 @@ paths:
|
||||||
properties:
|
properties:
|
||||||
export_type:
|
export_type:
|
||||||
description: |
|
description: |
|
||||||
Whether to create a public export or a full export with member consent.
|
Whether to create a public or a standard data export.
|
||||||
|
|
||||||
- 1 = Public data export.
|
- 1 = Public data export.
|
||||||
- 2 = Full data export with member consent.
|
- 2 = Standard data export.
|
||||||
|
|
||||||
If not specified, defaults to 1.
|
If not specified, defaults to 1.
|
||||||
|
|
||||||
|
@ -13258,7 +13255,7 @@ paths:
|
||||||
tags: ["server_and_organizations"]
|
tags: ["server_and_organizations"]
|
||||||
x-requires-administrator: true
|
x-requires-administrator: true
|
||||||
description: |
|
description: |
|
||||||
Fetches which users have [consented](/help/export-your-organization#full-export-with-member-consent)
|
Fetches which users have [consented](/help/export-your-organization#configure-whether-administrators-can-export-your-private-data)
|
||||||
for their private data to be exported by organization administrators.
|
for their private data to be exported by organization administrators.
|
||||||
|
|
||||||
**Changes**: New in Zulip 10.0 (feature level 295).
|
**Changes**: New in Zulip 10.0 (feature level 295).
|
||||||
|
@ -22159,11 +22156,10 @@ components:
|
||||||
export_type:
|
export_type:
|
||||||
type: integer
|
type: integer
|
||||||
description: |
|
description: |
|
||||||
Whether the data export is a public data export or a
|
Whether the data export is a public or a standard data export.
|
||||||
full data export with member consent.
|
|
||||||
|
|
||||||
- 1 = Public data export.
|
- 1 = Public data export.
|
||||||
- 2 = Full data export with member consent.
|
- 2 = Standard data export.
|
||||||
|
|
||||||
**Changes**: New in Zulip 10.0 (feature level 304). Previously,
|
**Changes**: New in Zulip 10.0 (feature level 304). Previously,
|
||||||
the export type was not included in these objects because only
|
the export type was not included in these objects because only
|
||||||
|
|
Loading…
Reference in New Issue