From c55371e3058b5785aab54c07c567575df87af7f9 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 25 May 2023 09:14:09 +0300 Subject: [PATCH] Add changelog entry for the forget_rooms_on_leave default change for Synapse Related to: - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2698 - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2700 --- CHANGELOG.md | 14 ++++++++++++++ roles/custom/matrix-synapse/defaults/main.yml | 4 ++++ .../templates/synapse/homeserver.yaml.j2 | 2 +- 3 files changed, 19 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1b5118427..70b17b000 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,17 @@ +# 2023-05-25 + +## Enabling `forget_rooms_on_leave` by default for Synapse + +With the [Synapse v1.84.0 update](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2698), we've also **changed the default value** of the `forget_rooms_on_leave` setting of Synapse to a value of `true`. +This way, **when you leave a room, Synapse will now forget it automatically**. + +The upstream Synapse default is `false` (disabled), so that you must forget rooms manually after leaving. + +**We go against the upstream default** ([somewhat controversially](https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/2700)) in an effort to make Synapse leaner and potentially do what we believe most users would expect their homeserver to be doing. + +If you'd like to go back to the old behavior, add the following to your configuration: `matrix_synapse_forget_rooms_on_leave: false` + + # 2023-04-03 ## The matrix-jitsi role lives independently now diff --git a/roles/custom/matrix-synapse/defaults/main.yml b/roles/custom/matrix-synapse/defaults/main.yml index cda427e39..5903eb05b 100644 --- a/roles/custom/matrix-synapse/defaults/main.yml +++ b/roles/custom/matrix-synapse/defaults/main.yml @@ -928,6 +928,10 @@ matrix_synapse_room_list_publication_rules: matrix_synapse_default_room_version: "10" +# Controls whether leaving a room will automatically forget it. +# The upstream default is `false`, but we try to make Synapse less wasteful of resources, so we do things differently. +matrix_synapse_forget_rooms_on_leave: true + # Controls the Synapse `spam_checker` setting. # # If a spam-checker extension is enabled, this variable's value is set automatically by the playbook during runtime. diff --git a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 index ff2533977..a36df6fc0 100644 --- a/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 +++ b/roles/custom/matrix-synapse/templates/synapse/homeserver.yaml.j2 @@ -143,7 +143,7 @@ default_room_version: {{ matrix_synapse_default_room_version|to_json }} # Set to true to automatically forget rooms for users when they leave them, either # normally or via a kick or ban. Defaults to false. -forget_rooms_on_leave: true +forget_rooms_on_leave: {{ matrix_synapse_forget_rooms_on_leave | to_json }} # The GC threshold parameters to pass to `gc.set_threshold`, if defined #