diff options
| author | Patrick Cloke <clokep@users.noreply.github.com> | 2021-05-24 08:57:14 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-05-24 08:57:14 -0400 |
| commit | 316f89e87f462608a5e63ba567ad549330f1456a (patch) | |
| tree | 53818a06c95e7384071db45091b2c82fe6fcdb8e | |
| parent | Add missing entry to the table of contents of room admin API (#10043) (diff) | |
| download | synapse-316f89e87f462608a5e63ba567ad549330f1456a.tar.xz | |
Enable experimental spaces by default. (#10011)
The previous spaces_enabled flag now defaults to true and is exposed in the sample config.
| -rw-r--r-- | changelog.d/10011.feature | 1 | ||||
| -rw-r--r-- | docs/sample_config.yaml | 15 | ||||
| -rw-r--r-- | synapse/config/experimental.py | 19 | ||||
| -rw-r--r-- | synapse/config/homeserver.py | 2 |
4 files changed, 35 insertions, 2 deletions
diff --git a/changelog.d/10011.feature b/changelog.d/10011.feature new file mode 100644 index 0000000000..409140fb13 --- /dev/null +++ b/changelog.d/10011.feature @@ -0,0 +1 @@ +Enable experimental support for [MSC2946](https://github.com/matrix-org/matrix-doc/pull/2946) (spaces summary API) and [MSC3083](https://github.com/matrix-org/matrix-doc/pull/3083) (restricted join rules) by default. diff --git a/docs/sample_config.yaml b/docs/sample_config.yaml index 2952f2ba32..f0f9f06a6e 100644 --- a/docs/sample_config.yaml +++ b/docs/sample_config.yaml @@ -2943,3 +2943,18 @@ redis: # Optional password if configured on the Redis instance # #password: <secret_password> + + +# Enable experimental features in Synapse. +# +# Experimental features might break or be removed without a deprecation +# period. +# +experimental_features: + # Support for Spaces (MSC1772), it enables the following: + # + # * The Spaces Summary API (MSC2946). + # * Restricting room membership based on space membership (MSC3083). + # + # Uncomment to disable support for Spaces. + #spaces_enabled: false diff --git a/synapse/config/experimental.py b/synapse/config/experimental.py index a693fba877..cc67377f0f 100644 --- a/synapse/config/experimental.py +++ b/synapse/config/experimental.py @@ -29,9 +29,26 @@ class ExperimentalConfig(Config): self.msc2858_enabled = experimental.get("msc2858_enabled", False) # type: bool # Spaces (MSC1772, MSC2946, MSC3083, etc) - self.spaces_enabled = experimental.get("spaces_enabled", False) # type: bool + self.spaces_enabled = experimental.get("spaces_enabled", True) # type: bool if self.spaces_enabled: KNOWN_ROOM_VERSIONS[RoomVersions.MSC3083.identifier] = RoomVersions.MSC3083 # MSC3026 (busy presence state) self.msc3026_enabled = experimental.get("msc3026_enabled", False) # type: bool + + def generate_config_section(self, **kwargs): + return """\ + # Enable experimental features in Synapse. + # + # Experimental features might break or be removed without a deprecation + # period. + # + experimental_features: + # Support for Spaces (MSC1772), it enables the following: + # + # * The Spaces Summary API (MSC2946). + # * Restricting room membership based on space membership (MSC3083). + # + # Uncomment to disable support for Spaces. + #spaces_enabled: false + """ diff --git a/synapse/config/homeserver.py b/synapse/config/homeserver.py index c23b66c88c..5ae0f55bcc 100644 --- a/synapse/config/homeserver.py +++ b/synapse/config/homeserver.py @@ -57,7 +57,6 @@ class HomeServerConfig(RootConfig): config_classes = [ ServerConfig, - ExperimentalConfig, TlsConfig, FederationConfig, CacheConfig, @@ -94,4 +93,5 @@ class HomeServerConfig(RootConfig): TracerConfig, WorkerConfig, RedisConfig, + ExperimentalConfig, ] |