diff options
| author | Erik Johnston <erik@matrix.org> | 2019-02-25 15:08:18 +0000 |
|---|---|---|
| committer | Erik Johnston <erik@matrix.org> | 2019-02-25 15:08:18 +0000 |
| commit | 4b9e5076c40964a967a48a2c02623c81a43265aa (patch) | |
| tree | ae977487f07c0e64e406ada53655b3f69edb664e /contrib/purge_api/README.md | |
| parent | Docs and arg name clarification (diff) | |
| parent | Merge pull request #4723 from matrix-org/erikj/frontend_proxy_exception (diff) | |
| download | synapse-4b9e5076c40964a967a48a2c02623c81a43265aa.tar.xz | |
Merge branch 'develop' of github.com:matrix-org/synapse into anoa/public_rooms_federate
Diffstat (limited to 'contrib/purge_api/README.md')
| -rw-r--r-- | contrib/purge_api/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/contrib/purge_api/README.md b/contrib/purge_api/README.md new file mode 100644 index 0000000000..000bf35ca7 --- /dev/null +++ b/contrib/purge_api/README.md @@ -0,0 +1,16 @@ +Purge history API examples +========================== + +# `purge_history.sh` + +A bash file, that uses the [purge history API](/docs/admin_api/README.rst) to +purge all messages in a list of rooms up to a certain event. You can select a +timeframe or a number of messages that you want to keep in the room. + +Just configure the variables DOMAIN, ADMIN, ROOMS_ARRAY and TIME at the top of +the script. + +# `purge_remote_media.sh` + +A bash file, that uses the [purge history API](/docs/admin_api/README.rst) to +purge all old cached remote media. |