MirrorHub/synapse
0
0
Fork 1
mirror of https://mau.dev/maunium/synapse.git synced 2024-12-15 03:03:50 +01:00
Code Issues Projects Releases Wiki Activity

Merge pull request #6891 from matrix-org/babolivier/retention-doc-amend

Browse source 
Spell out that the last event sent to a room won't be deleted by a purge
This commit is contained in:
Brendan Abolivier 2020-02-12 20:12:20 +00:00 committed by GitHub
commit 6cd34da8b1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelog.d/6891.doc Normal file
View file

@ -0,0 +1 @@
Spell out that the last event sent to a room won't be deleted by a purge.

3
docs/admin_api/purge_history_api.rst
View file

@ -8,6 +8,9 @@ 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 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. paginate further back in the room from the point being purged from.
Note that Synapse requires at least one message in each room, so it will never
delete the last message in a room.
The API is: The API is:
``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]`` ``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]``

4
docs/message_retention_policies.md
View file

@ -42,6 +42,10 @@ purged according to its room's policy, then the receiving server will
process and store that event until it's picked up by the next purge job, process and store that event until it's picked up by the next purge job,
though it will always hide it from clients. though it will always hide it from clients.
Synapse requires at least one message in each room, so it will never
delete the last message in a room. It will, however, hide it from
clients.
## Server configuration ## Server configuration