Matrix instant discussion#

CLUB1 hosts an instant messaging server based on the Matrix protocol. This can serve as an alternative to platforms like WhatsApp or Discord.

Important

This service does not require a CLUB1 account, but registration is by invitation only. Each CLUB1 member can invite as many people as they wish.

To learn more about this choice, go to the associated thread on the forum.

Invitation#

Registration uses a virtual token system. CLUB1 members can create single-use tokens valid for 30 days, which they must then share with the people they wish to invite.

To create a token, you need to connect via SSH and run the matrixtoken command.

matrixtoken#

This command will create a token and then display it. It looks like a string of characters that you can copy and pass on.

Warning

In most terminals, Ctrl + C does not copy. Instead, you must use Ctrl + Shift + C, or right-click.

The token must then be entered during registration, via https://riot.club1.fr/#/register.

Invitation by email#

It is possible to share an invitation code via email in a single command!

matrixinvite#

Send a Matrix invitation by email.

To use it, add the destination email address after a space. For example:

matrixinvite manumacs@gouv.fr

But it can also be used in an interactive way, by omitting the email address, the program will ask for it itself.

The person will receive by email the invitation code, a link to the registration page, as well as the expiry date of the token.

General principles#

Matrix relies on the interaction of different servers. Each server allows the creation of internal discussion “rooms” for its users, but also allows seamless connection to rooms from other servers if they wish.

Matrix#

Protocol for decentralized instant messaging.

Its main advantage over the other similarly federated systems is to replicate data on all participating servers, in order to improve fault tolerance by guaranteeing an “eventual consistency”. — Wikipedia

Server#

A Matrix server allows users to create an account and stores message exchanges. At CLUB1, our server address is simply club1.fr or https://club1.fr. There’s no need to go to that address, you’ll need a client to access the messaging interface.

Username#

Lorsque l’on a un compte Matrix, on a une adresse Matrix, un peu comme une adresse email, à ceci près que le symbole @ est utilisé comme premier caractère, signalant qu’il s’agit d’une adresse utilisataire. Le symbole : est donc utilisé pour séparer l’identifiant du serveur :

@baby:club1.fr

Where baby is the identifier and club1.fr is the server to which the account is attached.

Room#

A Matrix room is a discussion stream that can accommodate any number of participants. They also have an address, which this time begins with a #:

#blabla-dauphins:club1.fr

Where blabla-dauphins is the name of the room and club1.fr is the server on which it was created and to which it is attached.

Note

It is possible, when creating a room, to prohibit access to users who are not registered on that particular server.

Client (connection interfaces)#

As with email, you can also choose your client, your interface, to connect to Matrix. There are options for all tastes, but most are still under development. Currently, the simplest and most reliable way to communicate via Matrix is to use Element, either as a Web client or on mobile.

🌌 interface Element Web sur Club1.fr

On distingue trois catégories principales : Clients Web (qui s’ouvrent dans un navigateur), Desktop (Linux, Windows, MacOS) et Mobile (Android, Iphone). Liste officielle des clients matrix.

Sur ordinateur (Desktop), il n’existe pas encore de logiciel suffisamment complet pour que cela soit intéressant, à part si vous êtes un·e amoureux·se du terminal, auquel cas, vous êtes invité·e·s à utiliser le superbe gomuks

Sur Android, certaines applications commencent à être matures. Il y a bien-sûr la version mobile de Element, mais on peut aussi préférer l’ambiance fluffy de FluffyChat

Important

Pour se connecter ailleurs que sur l’interface web de Club1, il faut bien spécifier que votre serveur est https://club1.fr !

How to use it (Element web interface)?#

Joining rooms#

Pour rejoindre des rooms, il suffit de cliquer sur explorer en haut à gauche de l’interface. Par défaut, seules les rooms du serveur local sont listées. Pour en afficher d’autres, il faut sélectionner un autre serveur depuis le menu déroulant ou cliquer sur ajouter un nouveau serveur.

Dans le panneau de gauche, les salons sont répartis en messages direct et salons. Cela sert à distinguer les discussions à deux personnes des discussions de groupes.

Creating rooms#

En cliquant sur le + à droite de messages direct ou salons, on a la possibilité de créer son propre salon. Dans le cas d’une discussion à deux, il suffit de choisir un destinataire, la room sera par défaut privée. Dans d’une discussion de groupe, il va falloir définir un nom, définir si elle va être privée ou publique, ainsi que l’activation ou non du chiffrement.

Warning

Encryption of discussions cannot be disabled later.

Formatting#

It is possible to format your message by selecting text in the message writing area, or by using Markdown, a simple formatting standard used by more and more sites.

Encryption#

The Matrix protocol allows for end-to-end encryption of messages, meaning that a message remains unreadable throughout its transmission and can only be deciphered upon arrival by the recipient. This adds a layer of complexity to communication, as Matrix requires verification of the various devices used. Specifically, it’s essential to ensure that all devices connected to the same account belong to the same person. To achieve this, a global passphrase is used: a longer, super-strong password that encrypts your messages.

Specific configurations#

CLUB1’s instance of Synapse has some specific configurations.

Table 3.1 Registration#

Paramètre

Valeur

Jeton requis à l’inscription

Oui (voir Invitation)

Captcha requis à l’inscription

Non

Email requis à l’inscription

Non

Salons rejoints à l’inscription

#decouverte:club1.fr et #bazar:club1.fr

The server has limited resources, so it cannot host and keep all discussions indefinitely. That is why the following parameters were changed.

Table 3.2 Resources and performance#

Paramètre

Valeur

Rétention des messages

3 ans

Rétention des médias locaux

2 ans

Rétention des médias distants

90 jours

Délai de suppression des salons vides

20 jours

Limite de complexité des salons

10

Présence

Désactivé

Other special configurations:

Table 3.3 Miscellaneous#

Paramètre

Valeur

Serveurs de clés de confiance

deuxfleurs.fr et sans-nuage.fr

See also

Software#

Synapse#

Matrix server written in Python. This is the reference implementation of a Matrix server and for now the only one that is advertised as “stable”. — Sources

Element#

Complete (Matrix client formerly “Riot”) available on many platforms. CLUB1 hosts an instance of the Web version of this client at https://riot.club1.fr. — Sources, Wikipedia