summary refs log tree commit diff
diff options
context:
space:
mode:
authorAnder Punnar <4ND3R@users.noreply.github.com>2017-10-14 13:25:42 +0300
committerGitHub <noreply@github.com>2017-10-14 13:25:42 +0300
commitb2e02084b82ca4340c1ccc039a0768a6c9c5fbd5 (patch)
tree06f469795c7985f15a478b7e3373c100c1435dd5
parentBump version and changelog (diff)
downloadsynapse-b2e02084b82ca4340c1ccc039a0768a6c9c5fbd5.tar.xz
make it absolutely clear that Purge History API does not remove all traces of events and message contents
because this topic pops up too often

#890 #1621 #1730 #2260 #2315 and so on
-rw-r--r--docs/admin_api/purge_history_api.rst2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/admin_api/purge_history_api.rst b/docs/admin_api/purge_history_api.rst
index 986efe40f9..08b3306366 100644
--- a/docs/admin_api/purge_history_api.rst
+++ b/docs/admin_api/purge_history_api.rst
@@ -4,6 +4,8 @@ Purge History API
 The purge history API allows server admins to purge historic events from their
 database, reclaiming disk space.
 
+**NB!** This will not delete local events (locally sent messages content etc) from the database, but will remove lots of the metadata about them and does dramatically reduce the on disk space usage
+
 Depending on the amount of history being purged a call to the API may take
 several minutes or longer. During this period users will not be able to
 paginate further back in the room from the point being purged from.