improve config panel

conf/homeserver.yaml

@@ -50,7 +50,7 @@ pid_file: /run/matrix-__APP__/homeserver.pid
 
 # The absolute URL to the web client which / will redirect to.
 #
-#web_client_location: https://riot.example.com/
+web_client_location: __WEB_CLIENT_LOCATION__
 
 # The public-facing base URL that clients use to access this Homeserver (not
 # including _matrix/...). This is the same URL a user might enter into the
@@ -122,12 +122,12 @@ presence:
 # public rooms directory through the client API, meaning that anyone can
 # query the room directory. Defaults to 'false'.
 #
-allow_public_rooms_without_auth: __ALLOW_PUBLIC_ROOMS__
+allow_public_rooms_without_auth: __ALLOW_PUBLIC_ROOMS_WITHOUT_AUTH__
 
 # If set to 'true', allows any other homeserver to fetch the server's public
 # rooms directory via federation. Defaults to 'false'.
 #
-allow_public_rooms_over_federation: __ALLOW_PUBLIC_ROOMS__
+allow_public_rooms_over_federation: __ALLOW_PUBLIC_ROOMS_OVER_FEDERATION__
 
 # The default room version for newly created rooms.
 #
@@ -978,7 +978,7 @@ media_storage_providers:
 # your reverse proxy's config. Notably Nginx has a small max body size by default.
 # See https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
 #
-max_upload_size: 100M
+max_upload_size: __MAX_UPLOAD_SIZE__
 
 # Maximum number of pixels that will be thumbnailed
 #
@@ -1200,7 +1200,7 @@ turn_user_lifetime: 1h
 # connect to arbitrary endpoints without having first signed up for a
 # valid account (e.g. by passing a CAPTCHA).
 #
-turn_allow_guests: __ALLOWED_ACCESS__
+turn_allow_guests: __TURN_ALLOW_GUESTS__
 
 
 ## Registration ##
@@ -1212,7 +1212,7 @@ turn_allow_guests: __ALLOWED_ACCESS__
 # you use either captcha, email, or token-based verification to verify that new users are not bots. In order to enable registration
 # without any verification, you must also set `enable_registration_without_verification`, found below.
 #
-enable_registration: __ALLOWED_ACCESS__
+enable_registration: __ENABLE_REGISTRATION__
 
 # Enable registration without email or captcha verification. Note: this option is *not* recommended,
 # as registration without verification is a known vector for spam and abuse. Defaults to false. Has no effect
@@ -1272,20 +1272,20 @@ enable_registration: __ALLOWED_ACCESS__
 # The user must provide all of the below types of 3PID when registering.
 #
 registrations_require_3pid:
- - email
+ - __REGISTRATIONS_REQUIRE_3PID__
 #  - msisdn
 
 # Explicitly disable asking for MSISDNs from the registration
 # flow (overrides registrations_require_3pid if MSISDNs are set as required)
 #
-#disable_msisdn_registration: true
+disable_msisdn_registration: __DISABLE_MSISDN_REGISTRATION__
 
 # Mandate that users are only allowed to associate certain formats of
 # 3PIDs with accounts on this server.
 #
-#allowed_local_3pids:
-#  - medium: email
-#    pattern: '^[^@]+@matrix\.org$'
+allowed_local_3pids:
+  - medium: __REGISTRATIONS_REQUIRE_3PID__
+    pattern: __ALLOWED_LOCAL_3PIDS__
 #  - medium: email
 #    pattern: '^[^@]+@vector\.im$'
 #  - medium: msisdn
@@ -1327,15 +1327,15 @@ registration_shared_secret: "__REGISTRATION_SHARED_SECRET__"
 # participate in rooms hosted on this server which have been made
 # accessible to anonymous users.
 #
-#allow_guest_access: false
+allow_guest_access: __ALLOW_GUEST_ACCESS__
 
 # The identity server which we suggest that clients should use when users log
 # in on this server.
 #
 # (By default, no suggestion is made, so it is left up to the client.
 # This setting is ignored unless public_baseurl is also explicitly set.)
 #
-#default_identity_server: https://matrix.org
+default_identity_server: __DEFAULT_IDENTITY_SERVER__
 
 # Handle threepid (email/phone etc) registration and password resets through a set of
 # *trusted* identity servers. Note that this allows the configured identity server to
@@ -1394,8 +1394,8 @@ account_threepid_delegates:
 # If the room already exists, make certain it is a publicly joinable
 # room. The join rule of the room must be set to 'public'.
 #
-#auto_join_rooms:
-#  - "#example:example.com"
+auto_join_rooms:
+  - "__AUTO_JOIN_ROOMS__"
 
 # Where auto_join_rooms are specified, setting this flag ensures that the
 # the rooms exist by creating them when the first user on the
@@ -1411,7 +1411,7 @@ account_threepid_delegates:
 # Defaults to true. Uncomment the following line to disable automatically
 # creating auto-join rooms.
 #
-#autocreate_auto_join_rooms: false
+autocreate_auto_join_rooms: __AUTOCREATE_AUTO_JOIN_ROOMS__
 
 # Whether the auto_join_rooms that are auto-created are available via
 # federation. Only has an effect if autocreate_auto_join_rooms is true.
@@ -1462,7 +1462,7 @@ account_threepid_delegates:
 #
 # Defaults to true.
 #
-#auto_join_rooms_for_guests: false
+auto_join_rooms_for_guests: __AUTO_JOIN_ROOMS_FOR_GUESTS__
 
 # Whether to inhibit errors raised when registering a new account if the user ID
 # already exists. If turned on, that requests to /register/available will always
@@ -2167,7 +2167,7 @@ __DOMAIN_WHITELIST_CLIENT__
 password_config:
    # Uncomment to disable password login
    #
-   #enabled: false
+   enabled: __PASSWORD_ENABLED__
 
    # Uncomment to disable authentication against the local password
    # database. This is ignored if `enabled` is false, and is only useful
@@ -2307,20 +2307,20 @@ email:
   # Uncomment the following to enable sending emails for messages that the user
   # has missed. Disabled by default.
   #
-  enable_notifs: true
+  enable_notifs: __ENABLE_NOTIFS__
 
   # Uncomment the following to disable automatic subscription to email
   # notifications for new users. Enabled by default.
   #
-  #notif_for_new_users: false
+  notif_for_new_users: __NOTIF_FOR_NEW_USERS__
 
   # Custom URL for client links within the email notifications. By default
   # links will be based on "https://matrix.to".
   #
   # (This setting used to be called riot_base_url; the old name is still
   # supported for backwards-compatibility but is now deprecated.)
   #
-  #client_base_url: "http://localhost/riot"
+  client_base_url: __CLIENT_BASE_URL__
 
   # Configure the time that a validation email will expire after sending.
   # Defaults to 1h.
@@ -2331,7 +2331,7 @@ email:
   # to the identity server as the org.matrix.web_client_location key. Defaults
   # to unset, giving no guidance to the identity server.
   #
-  #invite_client_location: https://app.element.io
+  invite_client_location: __INVITE_CLIENT_LOCATION__
 
   # Subjects to use when sending emails from Synapse.
   #
@@ -2450,12 +2450,12 @@ push:
 # Note that this option will only affect rooms created after it is set. It
 # will also not affect rooms created by other servers.
 #
-#encryption_enabled_by_default_for_room_type: invite
+encryption_enabled_by_default_for_room_type: __E2E_ENABLED_BY_DEFAULT__
 
 
 # Uncomment to allow non-server-admin users to create groups on this server
 #
-enable_group_creation: true
+enable_group_creation: __ENABLE_GROUP_CREATION__
 
 # If enabled, non server admins can only create groups with local parts
 # starting with this prefix

config_panel.toml

@@ -0,0 +1,209 @@
+version = "1.0"
+
+[homeserver]
+name = "Homeserver Privacy"
+services = ["__APP__"]
+
+    [homeserver.config]
+    name = "Configuration Options"
+
+            [homeserver.config.backup_before_upgrade]
+            ask = "Backup before upgrade"
+            type = "boolean"
+            yes = true
+            no = false
+            help = "Set to 'true' to backup the Synapse YunoHost App before each upgrade."
+
+            [homeserver.config.server_statistics]
+            ask = "Server statistics"
+            type = "boolean"
+            yes = true
+            no = false
+            help = "Set to 'true' to send anonymous statistics to Synapse to improve performance."
+            bind = "report_stats:/etc/matrix-__APP__/homeserver.yaml"
+
+    [homeserver.privacy]
+    name = "Data Privacy"
+
+            [homeserver.privacy.default_identity_server]
+            ask = "Identity server suggested to clients."
+            type = "url"
+            help = "By default, no suggestion is made, so it is left up to the client."
+            bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+            [homeserver.privacy.allow_public_rooms_without_auth]
+            ask = "Public rooms directory"
+            type = "boolean"
+            yes = true
+            no = false
+            help = "If set to 'false', requires authentication to access the server's public rooms directory through the client API and forbids any other homeserver to fetch the server's public rooms directory via federation."
+            bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+            [homeserver.privacy.allow_public_rooms_over_federation]
+            ask = "Public rooms directory"
+            type = "boolean"
+            yes = true
+            no = false
+            help = "If set to 'false', requires authentication to access the server's public rooms directory through the client API and forbids any other homeserver to fetch the server's public rooms directory via federation."
+            bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+[account]
+name = "Registration"
+services = ["__APP__"]
+
+    [account.registration]
+    name = "Account Registration"
+
+            [account.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"
+
+            [account.registration.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"
+
+            [account.registration.registrations_require_3pid]
+            ask = "Register only with all below types of 3PID."
+            type = "string"
+            help = "Defaults to: '- email'. Phone number: '- msisdn'"
+            bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+            [account.registration.disable_msisdn_registration]
+            ask = "Disable asking Phone Number in Registration flow."
+            type = "boolean"
+            yes = true
+            no = false
+            help = "Overrides above setting if MSISDNs are set as required."
+            bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+            [account.registration.allowed_local_3pids]
+            ask = "Register only with given formats of 3PIDs."
+            type = "string"
+            help = '''
+            allowed_local_3pids:
+              - medium: email            - medium: email
+                pattern: '^[^@]+@matrix\.org$'
+              - medium: msisdn
+                pattern: '\+33'
+            '''
+
+            [account.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"
+
+            [account.registration.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"
+
+[client]
+name = "Matrix Client"
+services = ["__APP__"]
+
+    [client.experience]
+    name = "User Experience"
+
+        [client.experience.max_upload_size]
+        ask = "Largest allowed media upload size in bytes."
+        type = "url"
+        help = "Defaults to: '10M' . If you are using a reverse proxy you may also need to set this value in your reverse proxy's config. Notably Nginx has a small max body size by default. See https://matrix-org.github.io/synapse/latest/reverse_proxy.html."
+        bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+        [client.experience.web_client_location]
+        ask = "URL to the web client which / will redirect to."
+        type = "url"
+        help = "Basically Element instance the server should redirect to."
+        bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+        [client.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"
+
+        [client.experience.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"
+
+        [client.experience.enable_group_creation]
+        ask = "Allow non-server-admin Users to create Spaces?"
+        type = "boolean"
+        yes = true
+        no = false
+        help = "Defaults to 'false'."
+        bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+        [client.experience.e2e_enabled_by_default]
+        ask = "End-to-End Encryption by default for locally-created Rooms"
+        type = "select"
+        choices = ["all", "invite", "off"]
+        help = '''
+        * "all": any locally-created room
+        * "invite": any room created with the "private_chat" or "trusted_private_chat" room creation presets
+        * "off": this option will take no effect
+        '''
+        bind = "encryption_enabled_by_default_for_room_type:/etc/matrix-__APP__/homeserver.yaml"
+
+    [client.welcome]
+    name = "Welcome User Experience"
+
+        [client.welcome.auto_join_rooms]
+        ask = "Auto Join new Users in following Rooms."
+        type = "string"
+        help = "Room should be public. If not existing, will be created as public and federated by default."
+        bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+        [client.welcome.autocreate_auto_join_rooms]
+        ask = "Create room for Auto Join if not existing."
+        type = "boolean"
+        yes = true
+        no = false
+        help = "Will be created as public and federated by default. Can be customised with the settings auto_join_*."
+        bind = ":/etc/matrix-__APP__/homeserver.yaml"
+
+        [client.welcome.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"
+
+        [client.welcome.password_enabled]
+        ask = "Enable Password Login?"
+        type = "boolean"
+        yes = true
+        no = false
+        help = "Defaults to 'true'."
+        bind = "password_config>enabled:/etc/matrix-__APP__/homeserver.yaml"
+
+        [client.welcome.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"
+
+        [client.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"