diff options
| author | Richard van der Hoff <1389908+richvdh@users.noreply.github.com> | 2018-11-07 14:06:41 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-07 14:06:41 +0000 |
| commit | c8ba79327b2a9c56ab98bee15c345d51f43b41a4 (patch) | |
| tree | a443fb008b2416a32b41a2d40b5cc0797059fd4c /contrib/purge_api/README.md | |
| parent | Remove some boilerplate in tests (#4156) (diff) | |
| parent | add purge_history.sh and purge_remote_media.sh scripts to contrib/purge_api/ (diff) | |
| download | synapse-c8ba79327b2a9c56ab98bee15c345d51f43b41a4.tar.xz | |
Merge pull request #4155 from rubo77/purge-api
add purge_history.sh and purge_remote_media.sh scripts
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. |