From 9fad223ad1d5ab3810e17cdb9323fe49f478f51c Mon Sep 17 00:00:00 2001 From: Pierre Bourdon Date: Sat, 12 Mar 2022 16:33:46 +0100 Subject: [PATCH] matrix-synapse: fix release notes and doc for #158605 changes --- .../from_md/release-notes/rl-2205.section.xml | 17 +++++++++++++++-- .../doc/manual/release-notes/rl-2205.section.md | 9 +++++++-- .../modules/services/matrix/matrix-synapse.xml | 6 +++--- 3 files changed, 25 insertions(+), 7 deletions(-) diff --git a/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml b/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml index 9cf27e56827..3c7c420ed89 100644 --- a/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml +++ b/nixos/doc/manual/from_md/release-notes/rl-2205.section.xml @@ -432,6 +432,12 @@ still supported, because you can set arbitrary values in this freeform type. + + The listeners.*.bind_address option was + renamed to bind_addresses in order to match + the upstream homeserver.yaml option name. + It is now also a list of strings instead of a string. + An example to make the required migration clearer: @@ -493,7 +499,7 @@ listeners = [ { port = 8448; - bind_address = [ + bind_addresses = [ "::" "0.0.0.0" ]; @@ -524,7 +530,14 @@ Additionally a few option defaults have been synced up with upstream default values, for example the max_upload_size grew from - 10M to 50M. + 10M to 50M. For the same + reason, the default media_store_path was + changed from ${dataDir}/media to + ${dataDir}/media_store if + system.stateVersion is at least + 22.05. Files will need to be manually moved + to the new location if the stateVersion is + updated. diff --git a/nixos/doc/manual/release-notes/rl-2205.section.md b/nixos/doc/manual/release-notes/rl-2205.section.md index 58a1b23d17b..3f366598f11 100644 --- a/nixos/doc/manual/release-notes/rl-2205.section.md +++ b/nixos/doc/manual/release-notes/rl-2205.section.md @@ -141,6 +141,9 @@ In addition to numerous new and upgraded packages, this release has the followin module (`services.matrix-synapse`) now need to be moved into `services.matrix-synapse.settings`. And while not all options you may use are defined in there, they are still supported, because you can set arbitrary values in this freeform type. + The `listeners.*.bind_address` option was renamed to `bind_addresses` in order to match the upstream `homeserver.yaml` option + name. It is now also a list of strings instead of a string. + An example to make the required migration clearer: Before: @@ -198,7 +201,7 @@ In addition to numerous new and upgraded packages, this release has the followin listeners = [ { port = 8448; - bind_address = [ + bind_addresses = [ "::" "0.0.0.0" ]; @@ -223,7 +226,9 @@ In addition to numerous new and upgraded packages, this release has the followin The secrets in your original config should be migrated into a YAML file that is included via `extraConfigFiles`. - Additionally a few option defaults have been synced up with upstream default values, for example the `max_upload_size` grew from `10M` to `50M`. + Additionally a few option defaults have been synced up with upstream default values, for example the `max_upload_size` grew from `10M` to `50M`. For the same reason, the default + `media_store_path` was changed from `${dataDir}/media` to `${dataDir}/media_store` if `system.stateVersion` is at least `22.05`. Files will need to be manually moved to the new + location if the `stateVersion` is updated. - The MoinMoin wiki engine (`services.moinmoin`) has been removed, because Python 2 is being retired from nixpkgs. diff --git a/nixos/modules/services/matrix/matrix-synapse.xml b/nixos/modules/services/matrix/matrix-synapse.xml index cdc4b4de1a7..cf33957d58e 100644 --- a/nixos/modules/services/matrix/matrix-synapse.xml +++ b/nixos/modules/services/matrix/matrix-synapse.xml @@ -119,7 +119,7 @@ in { listeners = [ { port = 8008; - bind_address = [ "::1" ]; + bind_addresses = [ "::1" ]; type = "http"; tls = false; x_forwarded = true; @@ -152,10 +152,10 @@ in { If you want to run a server with public registration by anybody, you can - then enable services.matrix-synapse.enable_registration = + then enable services.matrix-synapse.settings.enable_registration = true;. Otherwise, or you can generate a registration secret with pwgen -s 64 1 and set it with - . + . To create a new user or admin, run the following after you have set the secret and have rebuilt NixOS: