# \[Synapse\] Instant messaging server matrix network

**URL:** https://forum.yunohost.org/t/synapse-instant-messaging-server-matrix-network/4381
**Category:** Apps
**Tags:** synapse
**Created:** [February 17, 2018, 4:03pm UTC](https://forum.yunohost.org/t/synapse-instant-messaging-server-matrix-network/4381 "2018-02-17T16:03:01Z")
**Posts on this page:** 1
**Showing post:** 1

<div class="post-metadata">

### Author: ![Josue](https://forum.yunohost.org/user_avatar/forum.yunohost.org/josue/32/933_2.png) [@Josue](https://forum.yunohost.org/u/Josue)
#### Post date: [February 17, 2018, 4:03pm UTC](https://forum.yunohost.org/t/synapse-instant-messaging-server-matrix-network/4381/1 "2018-02-17T16:03:02Z")

</div>

# Synapse for YunoHost

![](https://matrix.org/blog/wp-content/uploads/2015/01/logo1.png)

[![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)

## 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:** 1.1.0

## Configuration

### Install for ARM arch (or slow arch)

For all slow or arm architecture it’s recommended to build the dh file before the install to have quicker install.  
You could built it by this cmd : `mkdir -p /etc/matrix-synapse && openssl dhparam -out /etc/matrix-synapse/dh.pem 2048 > /dev/null`  
After that you can install it without problem.

The package use a prebuild python virtualenvironnement. The binary are taken from this repos : [GitHub - Josue-T/synapse\_python\_build](https://github.com/Josue-T/synapse_python_build)  
The script to build the binary is also available.

### Web client

If you want a web client you can also install riot with this package : [GitHub - YunoHost-Apps/element\_ynh: Element package for YunoHost](https://github.com/YunoHost-Apps/riot_ynh) .

### Access by federation

To be accessible by the federation you need to put this following line in the dns configuration :

```auto
_matrix._tcp.<yourdomain.com> <ttl> IN SRV 10 0 <port> <synapse.server.name>

```

for example

```auto
_matrix._tcp.example.com. 3600 IN SRV 10 0 8448 synapse.example.com.

```

### Important Security Note

We do not recommend running Riot from the same domain name as your Matrix  
homeserver (synapse). The reason is the risk of XSS (cross-site-scripting)  
vulnerabilities that could occur if someone caused Riot to load and render  
malicious user generated content from a Matrix API which then had trusted  
access to Riot (or other apps) due to sharing the same domain.

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  
[Make it crystal clear that you should not run Vector on the same domain as a HS · Issue #1977 · element-hq/element-web · GitHub](https://github.com/vector-im/riot-web/issues/1977) for more details.

## Documentation

- Official documentation: [GitHub - matrix-org/synapse: Synapse: Matrix homeserver written in Python/Twisted.](https://github.com/matrix-org/synapse)
- YunoHost documentation: to be created ; feel free to help!

## YunoHost specific features

### Multi-users support

Supported with LDAP.

### Supported architectures

- x86-64b - ![](https://ci-apps.yunohost.org/ci/logs/synapse%20%28Official%29.svg)
- ARMv8-A - ![](https://ci-apps-arm.yunohost.org/ci/logs/synapse%20%28Official%29.svg)
- Jessie x86-64b - ![](https://ci-stretch.nohost.me/ci/logs/synapse%20%28Official%29.svg)

## Limitations

Synapse take a lot of ressurce. So in slow architecture (like small ARM board), this app could take a lot of CPU and RAM.

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: [GitHub · Where software is built](https://github.com/YunoHost-Apps/synapse_ynh/issues)
- Matrix website: [https://matrix.org/](https://matrix.org/)
- YunoHost website: [https://yunohost.org/](https://yunohost.org/)

## Additionnal informations

## Administration

**All documentation of this section is not warranted. A bad use of command could broke the app and all the data. So use theses command at your own risk.**

Before any manipulation it’s recommended to do a backup by this following command :

`sudo yunohost backup create --verbose --ignore-system --apps synapse`

### Set user as admin

Actually there are no function in the client interface to set a user as admin. So it’s possible to enable it manually in the database.

This following command will enable the admin access to the specified user :

```auto
su --command="psql matrix_synapse" postgres <<< "UPDATE users SET admin = 1 WHERE name = '@user_to_be_admin:domain.tld'"

```

### Disable backup in upgrade

To solve the issue [#30](https://github.com/YunoHost-Apps/synapse_ynh/issues/30) you can disable the upgrade in the upgrade by setting to true the key `disable_backup_before_upgrade` in the app setting. You can set it by this command :

`yunohost app setting synapse disable_backup_before_upgrade -v 1`

### 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 :

```auto
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.

### License

Synapse is published under the Apache License : [synapse/LICENSE at master · matrix-org/synapse · GitHub](https://github.com/matrix-org/synapse/blob/master/LICENSE)

* * *

## Changelog

**_Testing Branch_**

- 17 Apr [#42](https://github.com/YunoHost-Apps/synapse_ynh/pull/42)
  - Upgrade synapse to 0.27.3

- 1 May [#43](https://github.com/YunoHost-Apps/synapse_ynh/pull/43)
  - Upgrade synapse to 0.28.0

- 17 May [#46](https://github.com/YunoHost-Apps/synapse_ynh/pull/46)
  - Upgrade synapse to 0.28.1

**_Master branch (Official release)_**

- 16 Apr [#39](https://github.com/YunoHost-Apps/synapse_ynh/pull/39)
  - Upgrade synapse to 0.27.2

- 16 Apr [#35](https://github.com/YunoHost-Apps/synapse_ynh/pull/35)
  - Fix UnicodeDecodeError with python scripts

- 16 Apr [#36](https://github.com/YunoHost-Apps/synapse_ynh/pull/36)
  - Add info about Turnserver

- 16 Apr [#37](https://github.com/YunoHost-Apps/synapse_ynh/pull/37)
  - Fix ‘PS1: unbound variable’ on ARM architecture

- 13 Feb [#34](https://github.com/YunoHost-Apps/synapse_ynh/pull/34)
  - Add multi instance support
  - Remove offical helper in common.sh
  - Improve turnserver config
  - Update checkprocess
  - Check synapse is fully started before the end script
  - Use helper nginx ynh\_add\_nginx\_config
  - Use systemd helper
  - Use official version syntax
  - Use app\_package\_version helper
  - Put all experimental helper in specific file
  - Update script official Check
  - Fix from official check

* * *

## Developers infos

Please do your pull request to the testing branch.

To try the testing branch, please proceed like that:

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/synapse_ynh/tree/testing --debug
or
sudo yunohost app upgrade synapse -u https://github.com/YunoHost-Apps/synapse_ynh/tree/testing --debug

```

* * *

* * *

# Synapse for YunoHost

![](https://matrix.org/blog/wp-content/uploads/2015/01/logo1.png)

[![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)

## Overview

Instant messaging server matrix network.  
Un client de messagerie qui utilise le réseau matrix.

Yunohost chattroom with matrix : [https://riot.im/app/#/room/#yunohost:matrix.org](https://riot.im/app/#/room/#yunohost:matrix.org)

**Version actuelle:** 1.1.0

## Configuration

### Installation sur les architectures ARM (ou sur les architectures lentes)

Sur les architectures lent ou ARM il est recommendé de créer le fichier dh.pem avant l’installation. Cela permettra ensuite une installation plus rapide.  
La création de ce fichier peut être effectuée via la commande : `mkdir -p /etc/matrix-synapse && openssl dhparam -out /etc/matrix-synapse/dh.pem 2048 > /dev/null`  
Ensuite il est possible d’installer le package sans problèmes.

Cette app utilise un environnement virtuel python préfabriqué. Les binaires sont utilisé sont viennent du dépot suivant : [GitHub - Josue-T/synapse\_python\_build](https://github.com/Josue-T/synapse_python_build)  
Le script de compilation et de génération de cet envionnement vituel est aussi disponible dans ce dépot.

### Client web

Si vous voulez un client web vous pouvez aussi intaller l’app riot disponible ici : [GitHub - YunoHost-Apps/element\_ynh: Element package for YunoHost](https://github.com/YunoHost-Apps/riot_ynh) .

### Accès à la federation

Pour être accessible par la fédération vous devez mettre les lignes suivantes dans votre configuration DNS :

```auto
_matrix._tcp.<yourdomain.com> <ttl> IN SRV 10 0 <port> <synapse.server.name>

```

Par exemple

```auto
_matrix._tcp.example.com. 3600 IN SRV 10 0 8448 synapse.example.com.

```

### Note de sécurité

Nous ne recommendons pas d’utiliser Riot sur le même domaine que le serveur matrix (synapse). Pour plus d’information voir : [Make it crystal clear that you should not run Vector on the same domain as a HS · Issue #1977 · element-hq/element-web · GitHub](https://github.com/vector-im/riot-web/issues/1977) for more details.

## Documentation

- Documentation officielle : [GitHub - matrix-org/synapse: Synapse: Matrix homeserver written in Python/Twisted.](https://github.com/matrix-org/synapse)
- Documentation YunoHost : doit être crée !

## Fonction spécifiques YunoHost

### Support multiutilisateurs

Supporte l’autentification via LDAP.

### Architectures supportée

- x86-64b - ![](https://ci-apps.yunohost.org/ci/logs/synapse%20%28Official%29.svg)
- ARMv8-A - ![](https://ci-apps-arm.yunohost.org/ci/logs/synapse%20%28Official%29.svg)
- Jessie x86-64b - ![](https://ci-stretch.nohost.me/ci/logs/synapse%20%28Official%29.svg)

## Limitations

Synapse utilise beaucoup de ressources. Donc sur des architecutres lentes (commes les cartes ARM), cette app peut utiliser beaucoup de CPU et de RAM.

Cette app ne contient pas de réel interface web. Il est donc recommandé d’utiliser Riot comme client pour se connecter à cette app. Elle est disponible [ici](https://github.com/YunoHost-Apps/riot_ynh)

## Liens

- Report de bug: [GitHub · Where software is built](https://github.com/YunoHost-Apps/synapse_ynh/issues)
- Sie officiel de Matrix : [https://matrix.org/](https://matrix.org/)

### License

Synapse est builiée sous la licence Apache : [synapse/LICENSE at master · matrix-org/synapse · GitHub](https://github.com/matrix-org/synapse/blob/master/LICENSE)

* * *

## Derniers changements

**_Testing Branch_**

- 17 Apr [#42](https://github.com/YunoHost-Apps/synapse_ynh/pull/42)
  - Upgrade synapse to 0.27.3

- 17 May [#46](https://github.com/YunoHost-Apps/synapse_ynh/pull/46)
  - Upgrade synapse to 0.28.1

**_Master branch (Official release)_**

- 16 Apr [#39](https://github.com/YunoHost-Apps/synapse_ynh/pull/39)
  - Upgrade synapse to 0.27.2

- 16 Apr [#35](https://github.com/YunoHost-Apps/synapse_ynh/pull/35)
  - Fix UnicodeDecodeError with python scripts

- 16 Apr [#36](https://github.com/YunoHost-Apps/synapse_ynh/pull/36)
  - Add info about Turnserver

- 16 Apr [#37](https://github.com/YunoHost-Apps/synapse_ynh/pull/37)
  - Fix ‘PS1: unbound variable’ on ARM architecture

- 13 Feb [#34](https://github.com/YunoHost-Apps/synapse_ynh/pull/34)
  - Add multi instance support
  - Remove offical helper in common.sh
  - Improve turnserver config
  - Update checkprocess
  - Check synapse is fully started before the end script
  - Use helper nginx ynh\_add\_nginx\_config
  - Use systemd helper
  - Use official version syntax
  - Use app\_package\_version helper
  - Put all experimental helper in specific file
  - Update script official Check
  - Fix from official check

* * *

## Infos développeurs

Merci de faire vos pull request sur la branche testing.

Pour tester la branche testing, merci de procéder ainsi :

```bash
sudo yunohost app install https://github.com/YunoHost-Apps/synapse_ynh/tree/testing --debug
or
sudo yunohost app upgrade synapse -u https://github.com/YunoHost-Apps/synapse_ynh/tree/testing --debug

```

---

_[View the full topic](https://forum.yunohost.org/t/synapse-instant-messaging-server-matrix-network/4381)._