summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2017-10-23 13:18:12 +0100
committerErik Johnston <erik@matrix.org>2017-10-23 13:18:12 +0100
commit1de557975f126b96dc65db0a12544c34429632dd (patch)
tree42b73375a5136e34c1cb52be578aa113b2589673 /docs/admin_api
parentMerge pull request #2560 from matrix-org/rav/kill_pointless_method (diff)
parentMerge branch 'release-v0.24.0' of github.com:matrix-org/synapse (diff)
downloadsynapse-1de557975f126b96dc65db0a12544c34429632dd.tar.xz
Merge branch 'master' of github.com:matrix-org/synapse into develop
Diffstat (limited to 'docs/admin_api')
-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.