MatrixSynapse


Table of Contents
1. Chat Server (Matrix Synapse)
1.1. What is the Matrix?
1.2. How to access the Matrix?
1.3. Setting up your FreedomBox for Matrix
1.4. Federating with other Matrix instances

1. Chat Server (Matrix Synapse)

1.1. What is the Matrix?

Matrix is an open standard for interoperable, decentralized, real-time communication over IP. Synapse is the reference implementation of a Matrix server. It can be used to setup instant messaging on FreedomBox to host large chat rooms, end to end encrypted communication and audio/video calls. Each instance of a Matrix server federates with other instances such that all your contacts need not hold accounts on your server. See more detailed info about Matrix.

Note: The Matrix Synapse is available in FreedomBox starting with Plinth version 0.14.


1.2. How to access the Matrix?

We recommend the Riot client to access the Matrix server. You can download Riot for desktops. Mobile applications for Android and iOS are available from app stores.


1.3. Setting up your FreedomBox for Matrix

To enable Matrix, first navigate to the Chat Server (Matrix Synapse) page and install it. Matrix needs a valid domain name to be configured. After installation, you will be asked to configure it. You will be able to select a domain from a drop down menu of available domains. Domains are configured using System -> Configure page. After configuring a domain, you will see that the service is running. The service will be accessible on the configured FreedomBox domain. All the registered users will have their Matrix IDs as @username:domain. Currently, you will not be able to change the domain once is it configured.


1.4. Federating with other Matrix instances

You will be able to interact with any other person running another Matrix instance. This is done by simply starting a conversation with them using their matrix ID which is of the format @their-username:their-domain. You can also join rooms which are in another server and have audio/video calls with contacts on other server.