Fix for official release

README.md

@@ -1,14 +1,25 @@
 Synapse for YunoHost
 ====================
 
-Yunohost chattroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org)
+![](https://matrix.org/blog/wp-content/uploads/2015/01/logo1.png)
 
-[Yunohost project](https://yunohost.org/#/)
+[![Integration level](https://dash.yunohost.org/integration/synapse.svg)](https://ci-apps.yunohost.org/jenkins/job/synapse%20%28Community%29/lastBuild/consoleFull)  
+[![Install Synapse with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=synapse)
 
-[![Integration level](https://dash.yunohost.org/integration/synapse.svg)](https://ci-apps.yunohost.org/jenkins/job/synapse%20%28Community%29/lastBuild/consoleFull) 
+> *This package allow you to install synapse quickly and simply on a YunoHost server.  
+If you don't have YunoHost, please see [here](https://yunohost.org/#/install) to know how to install and enjoy it.*
 
-Setup
------
+Overview
+--------
+
+Instant messaging server matrix network.
+
+Yunohost chattroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org)
+
+**Shipped version:** 0.26.0
+
+Configuration
+-------------
 
 ### Install for ARM arch (or slow arch)
 
@@ -19,13 +30,9 @@ After that you can install it without problem.
 The package use a prebuild python virtualenvironnement. The binary are taken from this repos : https://github.com/Josue-T/synapse_python_build
 The script to build the binary is also available.
 
-### Package update package
-
-`sudo yunohost app upgrade synapse -u https://github.com/YunoHost-Apps/synapse_ynh`
-
 ### Web client
 
-If you want a web client you can also install riot with this package : https://github.com/YunoHost-Apps/riot_ynh . But 
+If you want a web client you can also install riot with this package : https://github.com/YunoHost-Apps/riot_ynh .
 
 ### Access by federation
 
@@ -50,24 +57,42 @@ We have put some coarse mitigations into place to try to protect against this
 situation, but it's still not good practice to do it in the first place.  See
 https://github.com/vector-im/riot-web/issues/1977 for more details.
 
-Install
--------
+Documentation
+-------------
+
+- Official documentation: https://github.com/matrix-org/synapse
+- YunoHost documentation: to be created ; feel free to help!
+
+YunoHost specific features
+--------------------------
+
+### Multi-users support
 
-From command line:
+Supported with LDAP.
 
-`sudo yunohost app install -l synapse https://github.com/YunoHost-Apps/synapse_ynh`
+### Supported architectures
 
-Upgrade
--------
+- Tested on x86_64
+- Tested on ARM (with specific build)
 
-From command line:
+Limitations
+-----------
 
-`sudo yunohost app upgrade synapse -u https://github.com/YunoHost-Apps/synapse_ynh`
+Synapse take a lot of ressurce. So in slow architecture (like small ARM board), this app could take a lot of CPU and RAM.
 
-Issue
+This app don't contains any real good web interface. So it's recommended to use Riot client to connect to this app. This app is available [here](https://github.com/YunoHost-Apps/riot_ynh)
+
+Links
+-----
+
+- Report a bug: https://github.com/YunoHost-Apps/synapse_ynh/issues
+- Matrix website: https://matrix.org/
+- YunoHost website: https://yunohost.org/
+
+Additionnal informations
 -----
 
-Any issue is welcome here : https://github.com/YunoHost-Apps/synapse_ynh/issues
+
 
 Administation
 -------------
@@ -93,8 +118,16 @@ To solve the issue [#30](https://github.com/YunoHost-Apps/synapse_ynh/issues/30)
 
 `yunohost app setting synapse disable_backup_before_upgrade -v 1`
 
-Migration from old package
---------------------------
+### Multi instance support
+
+To give a possiblity to have multiple domain you can use synapse in multiple instance. In this case all instance will run on differents port so it's really important to use put a SRV record in your domain. You can get the port that your need to put in your SRV record by this following command :
+```
+yunohost app setting synapse__<instancenumber> synapse_tls_port
+```
+
+Before to install a second instance of the app it's really recommend to update all instance already installed.
+
+### Migration from old package
 
 The old synapse package had some problem, the package has been reviewed in the summer 2017. The old package was made with the debian package with the synapse apt repos. The database used sqlite. To improve the performance and to have a better compatibility the new package use python virtual environment and postgresql as database. The Upgrade was made to make the migration from the old package to the new package. The part of this script is available here : https://github.com/YunoHost-Apps/synapse_ynh/blob/master/scripts/upgrade#L40-L119 .
 
@@ -109,19 +142,21 @@ To do a backup before the upgrade use this command : `sudo yunohost backup creat
 
 If anything fail while you are doing the upgrade please make an issue here : https://github.com/YunoHost-Apps/synapse_ynh/issues
 
-License
--------
+### License
 
 Synapse is published under the Apache License : https://github.com/matrix-org/synapse/blob/master/LICENSE
 
-To do
------
+---
+
+Developers infos
+----------------
 
-- Doc (issue about domain)
-- Test arm
-- Riot doc
-- Test production
+Please do your pull request to the testing branch.
 
-### Todo for official App
+To try the testing branch, please proceed like that:
 
-- Improve documentation
+```bash
+sudo yunohost app install https://github.com/YunoHost-Apps/synapse_ynh/tree/testing --verbose
+or
+sudo yunohost app upgrade synapse -u https://github.com/YunoHost-Apps/synapse_ynh/tree/testing --verbose
+```

check_process

@@ -1,36 +1,37 @@
 ;; General
-    auto_remove=1
-# Commentaire ignoré
     ; Manifest
         domain="domain.tld"    (DOMAIN)
-	path="/_matrix"	(PATH)
+        path="/_matrix/client/#/login"	(PATH)
         is_public=1 (PUBLIC|public=1|private=0)
     ; Checks
         pkg_linter=1
-        setup_sub_dir=0
+        setup_sub_dir=1
         setup_root=0
-        setup_nourl=1
+        setup_nourl=0
         setup_private=0
         setup_public=1
         upgrade=1
+        upgrade=1   from_commit=a62bce7dbc6bc0e1f1b4e872286ff124747ea009
+        upgrade=1   from_commit=f050f88fbfe7bad1bf74d4584ec62ffcf28248e7
         backup_restore=1
-        multi_instance=0
-        wrong_user=0
-        wrong_path=1
+        multi_instance=1
         incorrect_path=0
-        corrupt_source=1
-        fail_download_source=1
-        port_already_use=1 (8008)
-        final_path_already_use=1
+        port_already_use=1 (8448)
         change_url=0
 ;;; Levels
     Level 1=auto
     Level 2=auto
     Level 3=auto
+    # https://github.com/YunoHost-Apps/synapse_ynh/blob/master/conf/homeserver.yaml#L443-L454
     Level 4=1
     Level 5=auto
     Level 6=auto
     Level 7=auto
     Level 8=0
     Level 9=0
     Level 10=0
+;;; Upgrade options
+	; commit=a62bce7dbc6bc0e1f1b4e872286ff124747ea009
+		name=Before multi_instance
+	; commit=f050f88fbfe7bad1bf74d4584ec62ffcf28248e7
+		name=Old version package

conf/coturn-synapse.service

@@ -0,0 +1,27 @@
+[Unit]
+Description=coturn
+Documentation=man:coturn(1) man:turnadmin(1) man:turnserver(1)
+After=syslog.target network.target
+
+[Service]
+User=turnserver
+Group=turnserver
+Type=forking
+EnvironmentFile=/etc/default/coturn-__APP__
+PIDFile=/var/run/coturn-__APP__/turnserver.pid
+RuntimeDirectory=coturn-__APP__
+RuntimeDirectoryMode=0755
+ExecStart=/usr/bin/turnserver -o -c /etc/matrix-__APP__/coturn.conf $EXTRA_OPTIONS
+ExecStopPost=/bin/rm -f /var/run/coturn-__APP__/turnserver.pid
+Restart=on-abort
+
+LimitCORE=infinity
+LimitNOFILE=999999
+LimitNPROC=60000
+LimitRTPRIO=infinity
+LimitRTTIME=7000000
+CPUSchedulingPolicy=other
+UMask=0007
+
+[Install]
+WantedBy=multi-user.target

conf/homeserver.yaml

@@ -10,7 +10,7 @@ tls_certificate_path: "/etc/yunohost/certs/__DOMAIN__/crt.pem"
 tls_private_key_path: "/etc/yunohost/certs/__DOMAIN__/key.pem"
 
 # PEM dh parameters for ephemeral keys
-tls_dh_params_path: "/etc/matrix-synapse/dh.pem"
+tls_dh_params_path: "/etc/matrix-__APP__/dh.pem"
 
 # Don't bind to the https port
 no_tls: False
@@ -20,7 +20,7 @@ no_tls: False
 server_name: "__DOMAIN__"
 
 # When running as a daemon, the file to store the pid in
-pid_file: "/var/run/matrix-synapse.pid"
+pid_file: "/var/run/matrix-__APP__.pid"
 
 # Whether to serve a web client from the HTTP/HTTPS root resource.
 web_client: False
@@ -113,7 +113,7 @@ database:
     args:
         user: __SYNAPSE_DB_USER__
         password: __SYNAPSE_DB_PWD__
-        database: matrix_synapse
+        database: matrix___APP__
         host: localhost
         cp_min: 5
         cp_max: 10
@@ -123,7 +123,7 @@ event_cache_size: "10K"
 
 
 # A yaml python logging config file
-log_config: "/etc/matrix-synapse/log.yaml"
+log_config: "/etc/matrix-__APP__/log.yaml"
 
 # Stop twisted from discarding the stack traces of exceptions in
 # deferreds by waiting a reactor tick before running a deferred's
@@ -161,7 +161,7 @@ federation_rc_concurrent: 3
 
 
 # Directory where uploaded images and attachments are stored.
-media_store_path: "/var/lib/matrix-synapse/media"
+media_store_path: "/var/lib/matrix-__APP__/media"
 
 # The largest allowed upload size in bytes
 max_upload_size: "10M"
@@ -353,7 +353,7 @@ expire_access_token: False
 ## Signing Keys ##
 
 # Path to the signing key to sign messages with
-signing_key_path: "/etc/matrix-synapse/homeserver.signing.key"
+signing_key_path: "/etc/matrix-__APP__/homeserver.signing.key"
 
 # The keys that the server used to sign messages with but won't use
 # to sign new messages. E.g. it has lost its private key

conf/log.yaml

@@ -14,7 +14,7 @@ handlers:
   file:
     class: logging.handlers.RotatingFileHandler
     formatter: precise
-    filename: /var/log/matrix-synapse/homeserver.log
+    filename: /var/log/matrix-__APP__/homeserver.log
     maxBytes: 104857600
     backupCount: 10
     filters: [context]

conf/matrix-synapse.service

@@ -3,11 +3,11 @@ Description=Synapse Matrix homeserver
 
 [Service]
 Type=simple
-User=matrix-synapse
-WorkingDirectory=/var/lib/matrix-synapse
-EnvironmentFile=/etc/default/matrix-synapse
-ExecStartPre=/opt/yunohost/matrix-synapse/bin/python -m synapse.app.homeserver --config-path=/etc/matrix-synapse/homeserver.yaml --config-path=/etc/matrix-synapse/conf.d/ --generate-keys
-ExecStart=/opt/yunohost/matrix-synapse/bin/python -m synapse.app.homeserver --config-path=/etc/matrix-synapse/homeserver.yaml --config-path=/etc/matrix-synapse/conf.d/
+User=matrix-__APP__
+WorkingDirectory=/var/lib/matrix-__APP__
+EnvironmentFile=/etc/default/matrix-__APP__
+ExecStartPre=/opt/yunohost/matrix-__APP__/bin/python -m synapse.app.homeserver --config-path=/etc/matrix-__APP__/homeserver.yaml --config-path=/etc/matrix-__APP__/conf.d/ --generate-keys
+ExecStart=/opt/yunohost/matrix-__APP__/bin/python -m synapse.app.homeserver --config-path=/etc/matrix-__APP__/homeserver.yaml --config-path=/etc/matrix-__APP__/conf.d/
 Restart=always
 RestartSec=3
 

conf/python_source.src

@@ -0,0 +1,2 @@
+SOURCE_URL=https://github.com/matrix-org/synapse/archive/v0.26.0.tar.gz
+SOURCE_SUM=234dd5fa44895e855d11fbf50de9184d057977b10b296f594d2c3758f693eff3 

conf/turnserver.conf

@@ -5,10 +5,17 @@ realm=__DOMAIN__
 no-stun
 
 tls-listening-port=__TLS_PORT__
+alt-tls-listening-port=__TLS_ALT_PORT__
+cli-port=__CLI_PORT__
 
 cert=/etc/yunohost/certs/__DOMAIN__/crt.pem
 pkey=/etc/yunohost/certs/__DOMAIN__/key.pem
-dh-file=/etc/yunohost/certs/__DOMAIN__/dh.pem
+dh-file=/etc/matrix-__APP__/dh.pem
 
 no-sslv2
-no-sslv3
+no-sslv3
+no-udp
+no-tcp
+
+log-file=/var/log/matrix-__APP__/turnserver.log
+pidfile="/var/run/coturn-__APP__/turnserver.pid"

conf/virtualenv_activate

@@ -40,7 +40,7 @@ deactivate () {
 # unset irrelevant variables
 deactivate nondestructive
 
-VIRTUAL_ENV="/opt/yunohost/matrix-synapse"
+VIRTUAL_ENV="__FINAL_PATH__"
 export VIRTUAL_ENV
 
 _OLD_VIRTUAL_PATH="$PATH"

manifest.json

@@ -3,20 +3,20 @@
 	"id": "synapse",
 	"packaging_format": 1,
 	"requirements": {
-		"yunohost": ">= 2.7.2"
+		"yunohost": ">= 2.7.9"
 	},
 	"description": {
 		"en": "Instant messaging server who use matrix",
 		"fr": "Un serveur de messagerie instantané basé sur matrix"
 	},
-	"version": "0.26.0",
+	"version": "0.26.0~ynh1",
 	"url": "http://matrix.org",
 	"license": "Apache-2.0",
 	"maintainer": {
 		"name": "Josué Tille",
 		"email": "josue@tille.ch"
 	},
-	"multi_instance": false,
+	"multi_instance": true,
 	"services": [
 		"nginx"
 	],