summary refs log tree commit diff
path: root/synapse/config/experimental.py
blob: cc67377f0fe780e5bbdefd1d497415aebcc079d4 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# Copyright 2021 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from synapse.api.room_versions import KNOWN_ROOM_VERSIONS, RoomVersions
from synapse.config._base import Config
from synapse.types import JsonDict


class ExperimentalConfig(Config):
    """Config section for enabling experimental features"""

    section = "experimental"

    def read_config(self, config: JsonDict, **kwargs):
        experimental = config.get("experimental_features") or {}

        # MSC2858 (multiple SSO identity providers)
        self.msc2858_enabled = experimental.get("msc2858_enabled", False)  # type: bool

        # Spaces (MSC1772, MSC2946, MSC3083, etc)
        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
        """