installation_synapse.md

title	author
Installation de Synapse	Sacha BOUTON et Benoît MISPLON

Prérequis pour effectuer la procédure :

• Avoir une machine virtuelle basique fonctionnelle.
• Avoir connaissance du vocabulaire technique.
• Avoir une base de données basique fonctionnelle.
• Avoir effectué le premier accès au service http pour comprendre le fonctionnement.

1) Installation du paquet sous Debian

Premièrement, il nous faut installer Synapse, pour se faire on se rend sur leur site et plus précisement dans le guide d'installation sous Debian

Il suffit de rentrer les 4 commandes suivantes :

user@vm $ sudo -E apt install -y lsb-release wget apt-transport-https
user@vm $ sudo -E wget -O /usr/share/keyrings/matrix-org-archive-keyring.gpg https://packages.matrix.org/debian/matrix-org-archive-keyring.gpg
echo "deb [signed-by=/usr/share/keyrings/matrix-org-archive-keyring.gpg] https://packages.matrix.org/debian/ $(lsb_release -cs) main" |
    sudo tee /etc/apt/sources.list.d/matrix-org.list
user@vm $ sudo -E apt update
user@vm $ sudo -E apt install matrix-synapse-py3

Le serveur écrira ses messages à destination de l’administrateur (les logs) dans le fichier /var/log/matrix-synapse/homeserver.log.virtualisation.

1.2) Paramétrage spécifique pour une instance dans un réseau privé

Pour que notre serveur ne contacte aucun autre serveurs, il faut enlever les paramètres de la ligne trusted_key_servers dans le fichier /etc/matrix-synapse/homeserver.yaml.

user@vm $ sudo nano /etc/matrix-synapse/homeserver.yaml
Remplacer par trusted_key_servers: []

Ne pas oubliez de supprimer les serveurs déjà connus auparavant (ligne en dessous).Synapse

1.3) Utilisation d'une base Postgres

Doc utilisation postgres synapse

La bibliothèque C libpq permet aux programmes de communiquer avec le serveur de base de données PostgreSQL, elle est nécessaire au bon fonctionnement de postgres.

user@vm $ sudo apt install libpq5

Ensuite, on se place en tant qu'utilisateur postgres :

su - postgres

On détruit notre base de données au préalable créer :

dropdb matrix

On détruit également l'utilisateur qu'on avait créer avec :

dropuser matrix

On créer un nouvel utilisateur avec l'argument --pwprompt, pour pouvoir créer son mot de passe :

createuser --pwprompt synapse_user

On recréer ensuite une base de données avec les arguments suivants :

• --encoding : Spécifiie l'encodage utilisé, ici UTF-8
• --locale : Spécifie l'endroit où doit être utilisé la base de données.
• --template : Spécifie la template a utilisé sur notre base de données, après recherche, on utilise template0 sur des bases de données où les tables ne vont plus changer.
• --owner : Pour spécifier le propriétaire de la table, ici synapse_user que l'on vient de créer.

createdb --encoding=UTF8 --locale=C --template=template0 --owner=synapse_user synapse

Afin que notre serveur Synapse utilise par défaut une base de données postgresql, et non pas une base de données sqlite. Il faut encore une fois modifier le fichier /etc/matrix-synapse/homeserver.yaml, et changer la configuration du paramètre database comme ci-dessous :

database:
    name: psycopg2
    args:
        user: synapse_user
        password: synapse
        database: synapse
        host: 127.0.0.1
        cp_min: 5
        cp_max: 10

On redémarre synapse :

user@vm $ sudo systemctl restart matrix-synapse

Dans le fichier /etc/matrix-synapse/homeserver.yaml, on rajoute aussi la ligne :

registration_shared_secret: "synapse"

1.4 ) Création d'utilisateur

Pour créer un utilisateur on utilise la commande sudo register_new_matrix_user avec comme arguments :

• -u : Pour renseigner le nom d'utilisateur.
• -p : Pour renseigner le mot de passe de l'utilisateur.
• -a : Pour créer l'utilisateur en tant qu'admin.
• -c : Le chemin vers le fichier contenant le shared_secret.

user@vm $ sudo register_new_matrix_user -u [nom] -p [password] -a -c /etc/matrix-synapse/homeserver.yaml

Si on veut créer 2 utilisateurs, on répète deux fois la commande , en changeant le nom d'utilisateur (on peut avoir le même mot de passe cependant)

1.5) Connexion à votre serveur Matrix

Premièrement, on peut déjà ouvrir le site mis à disposition, ici.

Avant de faire quoi que ce soit sur le site, il faut d'abord sortir de la machine virtuelle et se rendre sur notre machine physique, afin de modifier nos scripts créer précedemment dans la Procédure 1 :

login@phy $ nano .ssh/config

Puis, dans le script VM, on rajoute les deux lignes suivantes :

LocalForward 0.0.0.0:8080 192.168.194.3:8080
LocalForward 0.0.0.0:8008 localhost:8008

On peut ensuite revenir sur notre machine virtuelle.

**Attention :** Il faut donc bien se connecter en utilisant le ssh vm, sinon le script ne sera pas utilisé et le serveur ne sera pas opérationnel.

On peut maintenant s'occuper du site, si on clique sur le lien on arrive sur la page d'accueil avec une proposition de se connecter, ce qui va nous interesser est le serveur d'accueil.

Il faut modifier le serveur d'accueil de tel sorte qu'il respecte le schéma suivant

http://[machine].iutinfo.fr:8008

Si votre serveur est lancé correctement, cela devrait s'afficher en vert.

Ensuite, on peut appuyer sur Continuer et rentrer les logins utilisateurs créer au préalable, pour ma part id : Sacha pswrd : sacha.

On arrive ensuite sur la proposition de création d'une sauvegarde sécurisée .

A partir de là, on peut cliquer sur Annuler, en effet notre configuration actuelle ne permet pas de vérifier l'utilisateur et donc le processus de création va échouer.

En arrivant sur la page d'accueil d'Element, on aperçoit à droite le bouton +. Celui-ci sers à créer un espace afin de discuter et tester si notre connexion fonctionne bien. Pour se faire :

• Créer un espace
• Public ou privée
• Aller sur l'accueil de l'espace

A partir de l'accueil de l'espace, on peut inviter des utilisateurs, c'est là que la deuxième personne de votre binôme rentre en jeu. Celui-ci aura juste à se connecter au même serveur que vous et utiliser l'autre utilisateur au préable créer.

Pour inviter quelqu'un on suit la syntaxe suivante :

@[nomutilisateur]:[serveuraccueil]

Ici, on a choisit d'utiliser comme serveur d'accueil acajou13.

On peut voir maintenant qu'en allant sur notre serveur créer que l'on peut bien se parler !

1.6) Activation de l'enregistrement des utilisateurs

Afin d'autoriser l'enregistrement des utilisateurs, il faut rajouter la ligne enable_registration et mettre la valeur à true dans le fichier /etc/matrix-synapse/homeserver.yaml.

enable_registration: true
enable_registration_without_verification: true

Note : on peut aussi ajouter la deuxième ligne, cela évite la vérification.

Une fois cela fait, on peut passer à l'installation d'Element.