YunoHost-Apps · Josue-T · Mar 8, 2024 · Oct 31, 2023 · Oct 31, 2023 · Nov 1, 2023
diff --git a/README.md b/README.md
@@ -52,7 +52,7 @@ for example
 ```
 _matrix._tcp.example.com. 3600    IN      SRV     10 0 SYNAPSE_PORT synapse.example.com.
 ```
-You need to replace SYNAPSE_PORT by the real port. This port can be obtained by the command: `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port`
+You need to replace SYNAPSE_PORT by the real port. This port can be obtained by the command: `yunohost app setting SYNAPSE_INSTANCE_NAME port_synapse_tls`
 
 For more details, see : https://github.com/matrix-org/synapse/blob/master/docs/federate.md
 
@@ -66,8 +66,8 @@ https://federationtester.matrix.org/ can be used to easily debug federation issu
 
 For Voip and video conferencing a turnserver is also installed (and configured). The turnserver listens on two UDP and TCP ports. You can get them with these commands:
 ```
-yunohost app setting synapse turnserver_tls_port
-yunohost app setting synapse turnserver_alt_tls_port
+yunohost app setting synapse port_turnserver_tls
+yunohost app setting synapse port_turnserver_alt_tls
 
 ```
 The turnserver will also choose a port dynamically when a new call starts. The range is between 49153 - 49193.
@@ -162,12 +162,6 @@ Then, to log in the API with your credentials, you need to set your user as admi
 
 ### Upgrade
 
-By default a backup is made before the upgrade. If for some reason you want to upgrade without backup:
-- Call the command with the `-b` flag: `yunohost app upgrade synapse -b`
-- Disable the setting `Backup before upgrade` in the Config Panel. Or with command line:
-
-`yunohost app setting synapse backup_before_upgrade -v 0`
-
 After this settings will be applied for **all** next upgrade.
 
 From command line:
@@ -201,15 +195,17 @@ Use the `--purge` flag with the command, or remove it manually to purge app user
 
 To give a possibility to have multiple domains you can use multiple instances of synapse. In this case all instances will run on different ports so it's really important to put a SRV record in your domain. You can get the port that you need to put in your SRV record with this following command:
 ```
-yunohost app setting synapse__<instancenumber> synapse_tls_port
+yunohost app setting synapse__<instancenumber> port_synapse_tls
 ```
 
 Before installing a second instance of the app it's really recommended to update all existing instances.
 
 ## Documentation and resources
 
 * Official app website: <https://matrix.org/>
+* Official admin documentation: <https://matrix-org.github.io/synapse/latest/welcome_and_overview.html>
 * Upstream app code repository: <https://github.com/matrix-org/synapse>
+* YunoHost Store: <https://apps.yunohost.org/app/synapse>
 * Report a bug: <https://github.com/YunoHost-Apps/synapse_ynh/issues>
 
 ## Developer info

diff --git a/README_fr.md b/README_fr.md
@@ -52,7 +52,7 @@ for example
 ```
 _matrix._tcp.example.com. 3600    IN      SRV     10 0 SYNAPSE_PORT synapse.example.com.
 ```
-You need to replace SYNAPSE_PORT by the real port. This port can be obtained by the command: `yunohost app setting SYNAPSE_INSTANCE_NAME synapse_tls_port`
+You need to replace SYNAPSE_PORT by the real port. This port can be obtained by the command: `yunohost app setting SYNAPSE_INSTANCE_NAME port_synapse_tls`
 
 For more details, see : https://github.com/matrix-org/synapse/blob/master/docs/federate.md
 
@@ -66,8 +66,8 @@ https://federationtester.matrix.org/ can be used to easily debug federation issu
 
 For Voip and video conferencing a turnserver is also installed (and configured). The turnserver listens on two UDP and TCP ports. You can get them with these commands:
 ```
-yunohost app setting synapse turnserver_tls_port
-yunohost app setting synapse turnserver_alt_tls_port
+yunohost app setting synapse port_turnserver_tls
+yunohost app setting synapse port_turnserver_alt_tls
 
 ```
 The turnserver will also choose a port dynamically when a new call starts. The range is between 49153 - 49193.
@@ -162,12 +162,6 @@ Then, to log in the API with your credentials, you need to set your user as admi
 
 ### Upgrade
 
-By default a backup is made before the upgrade. If for some reason you want to upgrade without backup:
-- Call the command with the `-b` flag: `yunohost app upgrade synapse -b`
-- Disable the setting `Backup before upgrade` in the Config Panel. Or with command line:
-
-`yunohost app setting synapse backup_before_upgrade -v 0`
-
 After this settings will be applied for **all** next upgrade.
 
 From command line:
@@ -201,15 +195,17 @@ Use the `--purge` flag with the command, or remove it manually to purge app user
 
 To give a possibility to have multiple domains you can use multiple instances of synapse. In this case all instances will run on different ports so it's really important to put a SRV record in your domain. You can get the port that you need to put in your SRV record with this following command:
 ```
-yunohost app setting synapse__<instancenumber> synapse_tls_port
+yunohost app setting synapse__<instancenumber> port_synapse_tls
 ```
 
 Before installing a second instance of the app it's really recommended to update all existing instances.
 
 ## Documentations et ressources
 
 * Site officiel de l’app : <https://matrix.org/>
+* Documentation officielle de l’admin : <https://matrix-org.github.io/synapse/latest/welcome_and_overview.html>
 * Dépôt de code officiel de l’app : <https://github.com/matrix-org/synapse>
+* YunoHost Store: <https://apps.yunohost.org/app/synapse>
 * Signaler un bug : <https://github.com/YunoHost-Apps/synapse_ynh/issues>
 
 ## Informations pour les développeurs

diff --git a/conf/armv7_bookworm.src b/conf/armv7_bookworm.src
diff --git a/conf/armv7_bullseye.src b/conf/armv7_bullseye.src
diff --git a/conf/coturn-synapse.service b/conf/coturn-synapse.service
@@ -1,7 +1,7 @@
 [Unit]
 Description=Coturn
 Documentation=man:coturn(1) man:turnadmin(1) man:turnserver(1)
-After=syslog.target network.target
+After=syslog.target network-online.target
 
 [Service]
 User=turnserver

diff --git a/conf/homeserver.yaml b/conf/homeserver.yaml
@@ -285,7 +285,7 @@ listeners:
   # will also need to give Synapse a TLS key and certificate: see the TLS section
   # below.)
   #
-  - port: __SYNAPSE_TLS_PORT__
+  - port: __PORT_SYNAPSE_TLS__
     type: http
     tls: true
     resources:
@@ -297,7 +297,7 @@ listeners:
   # If you plan to use a reverse proxy, please see
   # https://matrix-org.github.io/synapse/latest/reverse_proxy.html.
   #
-  - port: __PORT__
+  - port: __PORT_SYNAPSE__
     tls: false
     type: http
     x_forwarded: true
@@ -801,9 +801,9 @@ database:
  name: psycopg2
  #txn_limit: 10000
  args:
-   user: __SYNAPSE_DB_USER__
-   password: __SYNAPSE_DB_PWD__
-   database: __SYNAPSE_DB_NAME__
+   user: __DB_USER__
+   password: __DB_PWD__
+   database: __DB_NAME__
    host: localhost
    port: 5432
    cp_min: 5
@@ -956,7 +956,7 @@ log_config: "/etc/matrix-__APP__/log.yaml"
 
 # Directory where uploaded images and attachments are stored.
 #
-media_store_path: "/home/yunohost.app/matrix-__APP__/media"
+media_store_path: "__DATA_DIR__/media"
 
 # Media storage providers allow media to be stored in different
 # locations.
@@ -970,7 +970,7 @@ media_storage_providers:
    # Whether to wait for successful storage for local uploads
    store_synchronous: false
    config:
-      directory: "/home/yunohost.app/matrix-__APP__/media_storage"
+      directory: "__DATA_DIR__/media_storage"
 
 # The largest allowed upload size in bytes
 #
@@ -1178,7 +1178,7 @@ oembed:
 
 # The public URIs of the TURN server to give to clients
 #
-turn_uris: [ "turn:__DOMAIN__:__TURNSERVER_TLS_PORT__?transport=udp", "turn:__DOMAIN__:__TURNSERVER_TLS_PORT__?transport=tcp" ]
+turn_uris: [ "turn:__DOMAIN__:__PORT_TURNSERVER_TLS__?transport=udp", "turn:__DOMAIN__:__PORT_TURNSERVER_TLS__?transport=tcp" ]
 
 # The shared secret used to compute passwords for the TURN server
 #
@@ -1271,9 +1271,7 @@ enable_registration: __ENABLE_REGISTRATION__
 
 # The user must provide all of the below types of 3PID when registering.
 #
-registrations_require_3pid:
- - email
-# - msisdn
+_REGISTRATION_REQUIRE_3PID_SED_PARAM_
 
 # Explicitly disable asking for MSISDNs from the registration
 # flow (overrides registrations_require_3pid if MSISDNs are set as required)
@@ -1283,6 +1281,7 @@ disable_msisdn_registration: __DISABLE_MSISDN_REGISTRATION__
 # Mandate that users are only allowed to associate certain formats of
 # 3PIDs with accounts on this server.
 #
+_ALLOWD_LOCAL_3PIDS_SED_PARAM_
 #allowed_local_3pids:
 #  - medium: email
 #    pattern: '^[^@]+@vector\.im$'
@@ -1356,9 +1355,9 @@ default_identity_server: __DEFAULT_IDENTITY_SERVER__
 # by the Matrix Identity Service API specification:
 # https://matrix.org/docs/spec/identity_service/latest
 #
-# As email delegates is managed by the synapse server itself this email section is 
+# As email delegates is managed by the synapse server itself this email section is
 # not necessary but msisdn format is still composed by msisdn: <value> on a new line
-account_threepid_delegates: 
+account_threepid_delegates:
     msisdn: __ACCOUNT_THREEPID_DELEGATES_MSISDN__
     #email: https://example.com     # Delegate email sending to example.com
     #msisdn: http://localhost:8090  # Delegate SMS sending to this local process
@@ -1395,8 +1394,7 @@ 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_SED_PARAM_
 
 # Where auto_join_rooms are specified, setting this flag ensures that the
 # the rooms exist by creating them when the first user on the
@@ -2089,7 +2087,7 @@ sso:
     # By default, this list contains only the login fallback page.
     #
     client_whitelist:
-__DOMAIN_WHITELIST_CLIENT__
+_DOMAIN_WHITELIST_CLIENT_
 
     # Uncomment to keep a user's profile fields in sync with information from
     # the identity provider. Currently only syncing the displayname is
@@ -2247,12 +2245,10 @@ password_providers:
           uid: "uid"
           mail: "mail"
           name: "givenName"
-       bind_dn: "uid=__SYNAPSE_USER_APP__,ou=users,dc=yunohost,dc=org"
-       bind_password: __SYNAPSE_USER_APP_PWD__
        filter: "(&(objectClass=posixAccount)(permission=cn=__APP__.main,ou=permission,dc=yunohost,dc=org))"
 
 
-    
+
 # Configuration for sending emails from Synapse.
 #
 # Server admins can configure custom templates for email content. See
@@ -2270,8 +2266,8 @@ email:
   # Username/password for authentication to the SMTP server. By default, no
   # authentication is attempted.
   #
-  smtp_user: __SYNAPSE_USER_APP__
-  smtp_pass: __SYNAPSE_USER_APP_PWD__
+  smtp_user: __APP__
+  smtp_pass: __MAIL_PWD__
 
   # Uncomment the following to require TLS transport security for SMTP.
   # By default, Synapse will connect over plain text, and will then switch to
@@ -2298,7 +2294,7 @@ email:
   # Note that the placeholder must be written '%(app)s', including the
   # trailing 's'.
   #
-  notif_from: "Your Friendly %(app)s Home Server <__SYNAPSE_USER_APP__@__DOMAIN__>"
+  notif_from: "Your Friendly %(app)s Home Server <__APP__@__DOMAIN__>"
 
   # app_name defines the default value for '%(app)s' in notif_from and email
   # subjects. It defaults to 'Matrix'.

diff --git a/conf/matrix-synapse.service b/conf/matrix-synapse.service
@@ -4,7 +4,7 @@ After=network.target
 
 [Service]
 Type=simple
-User=matrix-__APP__
+User=__APP__
 WorkingDirectory=/opt/yunohost/matrix-__APP__
 BindPaths=/etc/matrix-__APP__
 EnvironmentFile=/etc/default/matrix-__APP__
@@ -41,7 +41,7 @@ CapabilityBoundingSet=~CAP_BLOCK_SUSPEND CAP_WAKE_ALARM
 CapabilityBoundingSet=~CAP_SYS_TTY_CONFIG
 CapabilityBoundingSet=~CAP_MAC_ADMIN CAP_MAC_OVERRIDE
 CapabilityBoundingSet=~CAP_NET_ADMIN CAP_NET_BROADCAST CAP_NET_RAW
-CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG 
+CapabilityBoundingSet=~CAP_SYS_ADMIN CAP_SYS_PTRACE CAP_SYSLOG
 
 [Install]
 WantedBy=multi-user.target
diff --git a/conf/nginx.conf b/conf/nginx.conf
@@ -1,26 +1,25 @@
-location __PATH__/ {
-        proxy_pass http://localhost:__PORT__;
+location __BASE_API_URL__/ {
+        proxy_pass http://localhost:__PORT_SYNAPSE__;
         proxy_set_header X-Forwarded-For $remote_addr;
         proxy_set_header X-Forwarded-Proto $scheme;
         proxy_set_header Host $host;
 
-        client_max_body_size 100M;
-
-        # Use the specific path for the php file. It's more secure than global php path
-        location __PATH__/cas_server.php {
-            alias /var/www/__APP__/;
-            fastcgi_split_path_info ^(.+?\.php)(/.*)$;
-            fastcgi_pass unix:/run/php__PHPVERSION__-fpm-__NAME__.sock;
-            include fastcgi_params;
-            fastcgi_param REMOTE_USER $remote_user;
-            fastcgi_param PATH_INFO $fastcgi_path_info;
-            fastcgi_param SCRIPT_FILENAME cas_server.php;
-        }
+        client_max_body_size __MAX_UPLOAD_SIZE__;
 }
 
+# Use the specific path for the php file. It's more secure than global php path
+location __BASE_API_URL__/cas_server.php {
+        alias /var/www/__APP__/;
+        fastcgi_split_path_info ^(.+?\.php)(/.*)$;
+        fastcgi_pass unix:/run/php/php__PHPVERSION__-fpm-__NAME__.sock;
+        include fastcgi_params;
+        fastcgi_param REMOTE_USER $remote_user;
+        fastcgi_param PATH_INFO $fastcgi_path_info;
+        fastcgi_param SCRIPT_FILENAME cas_server.php;
+}
 
 location /_synapse/ {
-        proxy_pass http://localhost:__PORT__;
+        proxy_pass http://localhost:__PORT_SYNAPSE__;
         proxy_set_header X-Forwarded-For $remote_addr;
         proxy_set_header X-Forwarded-Proto $scheme;
         proxy_set_header Host $host;

diff --git a/conf/server_name.conf b/conf/server_name.conf
@@ -1,5 +1,5 @@
 location /.well-known/matrix/server {
-    return 200 '{"m.server": "__DOMAIN__:__SYNAPSE_TLS_PORT__"}';
+    return 200 '{"m.server": "__DOMAIN__:__PORT_SYNAPSE_TLS__"}';
     add_header Content-Type application/json;
     add_header Access-Control-Allow-Origin '*';
 }
@@ -8,7 +8,7 @@ location /.well-known/matrix/client {
     return 200 '{
         "m.homeserver": { "base_url": "https://__DOMAIN__" },
         "im.vector.riot.jitsi": {"preferredDomain": "__JITSI_SERVER__"},
-        "im.vector.riot.e2ee": {"default": __E2E_ENABLED_BY_DEFAULT__ }
+        "im.vector.riot.e2ee": {"default": __E2E_ENABLED_BY_DEFAULT_CLIENT_CONFIG__ }
     }';
     add_header Content-Type application/json;
     add_header Access-Control-Allow-Origin '*';

diff --git a/conf/turnserver.conf b/conf/turnserver.conf
@@ -3,11 +3,11 @@ use-auth-secret
 static-auth-secret=__TURNSERVER_PWD__
 realm=__DOMAIN__
 
-tls-listening-port=__TURNSERVER_TLS_PORT__
-alt-tls-listening-port=__TURNSERVER_ALT_TLS_PORT__
+tls-listening-port=__PORT_TURNSERVER_TLS__
+alt-tls-listening-port=__PORT_TURNSERVER_ALT_TLS__
 min-port=49153
 max-port=49193
-cli-port=__CLI_PORT__
+cli-port=__PORT_CLI__
 
 cert=/etc/yunohost/certs/__DOMAIN__/crt.pem
 pkey=/etc/yunohost/certs/__DOMAIN__/key.pem
@@ -26,4 +26,4 @@ log-file=/var/log/matrix-__APP__/turnserver.log
 pidfile=/run/coturn-__APP__/turnserver.pid
 simple-log
 
-__TURN_EXTERNAL_IP__
+_TURN_EXTERNAL_IP_