synapse_ynh/config_panel.toml

version = "1.0"

[main]
name = "Main Settings"
services = ["matrix-__APP__"]

    [main.welcome]
    name = "Experience for new Users"

        [main.welcome.enable_registration]
        ask = "Enable Registration for new users."
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Defaults to 'false'. If 'true', it is highly recommended to use either captcha, email, or token-based verification to avoid SPAM."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [main.welcome.password_enabled]
        ask = "Enable Password Login?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "If disabled, Login with Non-YunoHost Users impossible. But it simplies Login process if your Matrix server only has YunoHost SSO Users."
        bind = "password_config>enabled:/etc/matrix-__APP__/homeserver.yaml"
        visible = "! enable_registration"

        [main.welcome.registrations_require_3pid]
        ask = "Registration requires all following 3PID personal identifier."
        type = "select"
        choices = ["false","email", "msisdn", "email&msisdn"]
        help = "! warning msisdn (Phone number) registration require a third party service which send confirmation token by SMS do not select any option including msisdn if you don't know what to do.\nDefaults to: 'email'."
        visible = "enable_registration"

        [main.welcome.allowed_local_3pids_email]
        ask = "Register only with given email formats."
        type = "tags"
        help = '( e.g. ^[^@]+@matrix\\\\.org$ ) Note that \\\ will write \\ as suggested in homeserver.yaml'
        visible = 'enable_registration && (registrations_require_3pid == "email" || registrations_require_3pid == "email&msisdn")'

        [main.welcome.allowed_local_3pids_msisdn]
        ask = "Register only with given phone number formats."
        type = "tags"
        help = '( e.g. \\\\+33 ) Note that \\\ will write \\ as suggested in homeserver.yaml'
        visible = 'enable_registration && (registrations_require_3pid == "email&msisdn" || registrations_require_3pid == "msisdn")'

        [main.welcome.disable_msisdn_registration]
        ask = "Disable asking Phone Number in Registration flow."
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Overrides 3PID settings if MSISDNs are set as required."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"
        visible = "enable_registration"

        [main.welcome.account_threepid_delegates_msisdn]
        ask = "specify a third party server to send confirmation code by SMS."
        type = "string"
        help = "! Mandatory for msisdn registration. Specify here the server which will send the configmation token by SMS (synapse can not do it for now). it mus be preced by '\n msisdn: ' then the url of the server (for now)"
        bind = ":/etc/matrix-__APP__/homeserver.yaml"
        visible = 'enable_registration && (registrations_require_3pid == "email&msisdn" || registrations_require_3pid == "msisdn")'
        
        [main.welcome.auto_join_rooms]
        ask = "Auto Join new Users in following Rooms:"
        type = "tags"
        help = "( e.g. \\\\#example:example.com )  Note that \\\\# will write # in homeserver.yaml. Users who register on this homeserver will automatically be joined to these rooms. If the room already exists, the join rule must be set to 'public'. See also next setting."
       
        [main.welcome.autocreate_auto_join_rooms]
        ask = "Auto-Create room for Auto Join if not existing?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Setting to false means that if the rooms are not manually created, users cannot be auto-joined. Auto-created rooms will be public and federated by default, this can be customised in CLI with the settings auto_join_*."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [main.welcome.notif_for_new_users]
        ask = "Enable email notifications for new users?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Defaults to 'true'."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"
        visible = "enable_notifs"

    [main.privacy]
    name = "Data Privacy"
    
        [main.privacy.text]
        ask = '''
        * "all": any locally-created room
        * "invite": any room created with the "private_chat" or "trusted_private_chat" room creation presets
        * "off": No encryption by default
        '''
        type = "markdown"

        [main.privacy.e2e_enabled_by_default]
        ask = "End-to-End Encryption by default for locally-created Rooms"
        type = "select"
        choices = ["all", "invite", "off"]
        help = "Note that encryption can always be turned on manually, even after creation."
        bind = "encryption_enabled_by_default_for_room_type:/etc/matrix-__APP__/homeserver.yaml"
        
        [main.privacy.allow_public_rooms_over_federation]
        ask = "Access Public Rooms Directory over Federation?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Disabled by default. If disabled, users on other homeserver will not be able to look for a public room on your homeserver. They will have to type the ID of the room to join."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [main.privacy.push_include_content]
        ask = "Disable content sharing inside push notification."
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Send content message and sender information in push notification. Set to false increase privacy when GAFAM notification service is used (ie: when element client is downloaded thrue Gplay store)."
        bind = "push>include_content:/etc/matrix-__APP__/homeserver.yaml"

    [main.experience]
    name = "User Experience"

        [main.experience.web_client_location]
        ask = "Element instance your HomeServer should redirect to."
        type = "url"
        help = "URL to the web client which / will redirect to."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [main.experience.enable_group_creation]
        ask = "Allow non-server-admin Users to create Spaces?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Disabled by default: only server admins can create Spaces"
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [main.experience.enable_notifs]
        ask = "Enable sending emails for messages the user missed?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Defaults to 'false'."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [main.experience.client_base_url]
        ask = "URL for client links within the email notifications."
        type = "url"
        help = "Used to be called 'riot_base_url', still supported"
        bind = ":/etc/matrix-__APP__/homeserver.yaml"
        visible = "enable_notifs"

[resources]
name = "Resource Usage"
services = ["matrix-__APP__", "nginx"]

    [resources.media]
    name = "Manage Media growth and clean-up"

        [resources.media.max_upload_size]
        ask = "Largest allowed media upload size in bytes."
        type = "string"
        help = "Defaults to: '10M' . Format : <value><[GMK]?>"
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

[advanced]
name = "Advanced Settings"
services = ["matrix-__APP__"]

    [advanced.help]
    name = "SETTINGS FOR EXPERTS IN SERVER ADMINISTRATION"

        [advanced.help.text]
        ask = '''
        !!There are security and privacy risks if you change these settings without knowing what you do!!
        '''
        type = "markdown"

    [advanced.others]
    name = "Others"

            [advanced.others.backup_before_upgrade]
            ask = "Backup before upgrade?"
            type = "boolean"
            yes = "true"
            no = "false"
            help = "!! If disabled, do a manual backup before upgrade !! Disable if your Synapse instance is huge and you prefer to disable the backup that is normally automatically done before each upgrade."

            [advanced.others.server_statistics]
            ask = "Server statistics"
            type = "boolean"
            yes = "true"
            no = "false"
            help = "Enable to send anonymous statistics to Synapse Developers to improve performance."
            bind = "report_stats:/etc/matrix-__APP__/homeserver.yaml"

    [advanced.guests]
    name = "Experience for Guests / Anonymous"

        [advanced.guests.invite_client_location]
        ask = "Web client location to direct users to during an invite."
        type = "url"
        help = "This is passed to the identity server as the org.matrix.web_client_location key. Defaults to unset, giving no guidance to the identity server."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [advanced.guests.allow_guest_access]
        ask = "Allow Users to Register as Guests?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Guests can participate on this server in rooms with guest access enabled, without a password/email/etc."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"

        [advanced.guests.auto_join_rooms_for_guests]
        ask = "Enable Auto Join Room for Guests?"
        type = "boolean"
        yes = "true"
        no = "false"
        help = "Defaults to 'true'."
        bind = ":/etc/matrix-__APP__/homeserver.yaml"
        visible = "allow_guest_access"

    [advanced.privacy]
    name = "Data Privacy"

            [advanced.privacy.enable_3pid_lookup]
            ask = "Allow discovering friends with phone number or email?"
            type = "boolean"
            yes = "true"
            no = "false"
            help = "Enable 3PIDs lookup requests to identity servers from this server. See Settings->General->Discovery in Element."
            bind = ":/etc/matrix-__APP__/homeserver.yaml"

            [advanced.privacy.default_identity_server]
            ask = "Identity server suggested to clients?"
            type = "url"
            help = "Identity server allows to discover, be discovered and invite people you know with phone number or email. If not set, users will probably chose centralized vector.im. See Settings->General->Discovery in Element."
            bind = ":/etc/matrix-__APP__/homeserver.yaml"

            [advanced.privacy.allow_public_rooms_without_auth]
            ask = "Access Public Rooms Directory without authentification?"
            type = "boolean"
            yes = "true"
            no = "false"
            help = "Disabled by default. If enabled, anyone can query the Public Rooms Directory (access through the client API). This only makes sense if you want everyone to be able to scroll your public room to see what's interesting on your Homeserver"
            bind = ":/etc/matrix-__APP__/homeserver.yaml"

    [advanced.registration]
    name = "Account Registration"

            [advanced.registration.registration_shared_secret]
            ask = "Shared Secret for Registration."
            type = "string"
            help = "Allows registration of standard or admin accounts, even if Registration disabled."
            bind = ":/etc/matrix-__APP__/homeserver.yaml"

            [advanced.registration.turn_allow_guests]
            ask = "Should guests be allowed to use the TURN server?"
            type = "boolean"
            yes = "true"
            no = "false"
            help = "This defaults to True, otherwise VoIP will be unreliable for guests. However, it does introduce a slight security risk as it allows users to connect to arbitrary endpoints without having first signed up for a valid account (e.g. by passing a CAPTCHA)."
            bind = ":/etc/matrix-__APP__/homeserver.yaml"