diff options
author | rubo77 <github@r.z11.de> | 2018-11-06 23:16:22 +0100 |
---|---|---|
committer | rubo77 <github@r.z11.de> | 2018-11-07 14:02:41 +0100 |
commit | 2904d133f34981cbccbc6b5e615ccd9ba511ab0d (patch) | |
tree | b292b83ca4c07fca2a4442a070b7ec7d6b5cc1bc /contrib/purge_api/README.md | |
parent | Add config variables for enabling terms auth and the policy name (#4142) (diff) | |
download | synapse-2904d133f34981cbccbc6b5e615ccd9ba511ab0d.tar.xz |
add purge_history.sh and purge_remote_media.sh scripts to contrib/purge_api/
Signed-off-by: Ruben Barkow <github@r.z11.de>
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. |