mirror of
https://github.com/zulip/zulip.git
synced 2025-11-05 06:23:38 +00:00
docs: Document the export_search compliance export tool.
This commit is contained in:
committed by
Tim Abbott
parent
e41ee10966
commit
bf00e44bde
@@ -41,6 +41,9 @@ service (or back):
|
|||||||
tool isn't applicable, including situations where an easily
|
tool isn't applicable, including situations where an easily
|
||||||
machine-parsable export format is desired.
|
machine-parsable export format is desired.
|
||||||
|
|
||||||
|
- [Compliance exports](#compliance-exports) allow a server
|
||||||
|
administrator to export messages matching a search query.
|
||||||
|
|
||||||
- Zulip also has an [HTML archive
|
- Zulip also has an [HTML archive
|
||||||
tool](https://github.com/zulip/zulip-archive), which is primarily
|
tool](https://github.com/zulip/zulip-archive), which is primarily
|
||||||
intended for public archives, but can also be useful to
|
intended for public archives, but can also be useful to
|
||||||
@@ -444,6 +447,35 @@ rm -rf /home/zulip/uploads/*/2/
|
|||||||
|
|
||||||
Once that's done, you can simply re-run the import process.
|
Once that's done, you can simply re-run the import process.
|
||||||
|
|
||||||
|
## Compliance exports
|
||||||
|
|
||||||
|
In some circumstances, corporate or legal compliance may require
|
||||||
|
performing selective data exports. This can be done with the
|
||||||
|
`export_search` command-line tool, which lets you specify the
|
||||||
|
following parameters when exporting messages:
|
||||||
|
|
||||||
|
- Search keywords in the message text.
|
||||||
|
- Message sender.
|
||||||
|
- Time range for when messages were sent.
|
||||||
|
|
||||||
|
For example, to search for messages containing the word "wonderland"
|
||||||
|
between November 1st and 6th, from `alice@example.com`:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ /home/zulip/deployments/current/manage.py export_search --output compliance-export.json
|
||||||
|
-r zulip \
|
||||||
|
--after '2022-11-01 00:00:00' --before '2022-11-06 14:00:00' \
|
||||||
|
--sender alice@example.com \
|
||||||
|
wonderland
|
||||||
|
```
|
||||||
|
|
||||||
|
The results are written to a JSON file. The contents of previous
|
||||||
|
versions of edited messages are not searched, nor are deleted
|
||||||
|
messages.
|
||||||
|
|
||||||
|
See `/home/zulip/deployments/current/manage.py export_search --help`
|
||||||
|
for more details on supported options.
|
||||||
|
|
||||||
## Database-only backup tools
|
## Database-only backup tools
|
||||||
|
|
||||||
The [Zulip-specific backup tool documented above](#backups) is perfect
|
The [Zulip-specific backup tool documented above](#backups) is perfect
|
||||||
|
|||||||
Reference in New Issue
Block a user