Differences between revisions 7 and 8
Revision 7 as of 2019-01-14 20:16:04
Size: 2375
Editor: Drahtseil
Comment: System requirements
Revision 8 as of 2019-02-13 09:09:45
Size: 2700
Comment: Remove pop-culture references. Add notes about large rooms and memory usage.
Deletions are marked like this. Additions are marked like this.
Line 3: Line 3:
=== What is the Matrix? ===
[[https://matrix.org/|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. [[https://matrix.org/docs/guides/faq.html|See]] more detailed info about Matrix.
=== What is Matrix? ===
[[https://matrix.org/|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.
Matrix Synapse is a federated application where chat rooms can exist on any server and users from any server in the federated network can join them. [[https://matrix.org/docs/guides/faq.html|Learn more]] about Matrix.
Line 6: Line 7:
'''Note:''' The Matrix Synapse is available in !FreedomBox starting with Plinth version 0.14. '''Available since:''' version 0.14.0
Line 8: Line 9:
=== How to access the Matrix? === === How to access your Matrix Synapse server? ===
Line 10: Line 11:
We recommend the [[https://riot.im|Riot]] client to access the Matrix server. You can [[https://riot.im/desktop.html|download]] Riot for desktops. Mobile applications for Android and iOS are available from app stores. We recommend the [[https://riot.im|Riot]] client to access the Matrix Synapse server. You can [[https://riot.im/desktop.html|download]] Riot for desktops. Mobile applications for Android and iOS are available from their respective app stores.
Line 12: Line 13:
=== Setting up your FreedomBox for Matrix === === Setting up Matrix Synapse on your FreedomBox ===
Line 15: Line 16:

 * [[https://github.com/matrix-org/synapse/blob/master/README.rst|System requirements:]] ''At least 1GB of free RAM if you want to join large public rooms like #matrix:matrix.org''
Line 21: Line 20:

=== Memory usage ===
The Synapse reference server implemented in Python is known to be quite RAM hungry, especially when loading large rooms with thousands of members like #matrix:matrix.org. It is recommended to avoid joining such rooms if your !FreedomBox device only has 1 GiB RAM or less. Rooms with up to a hundred members should be safe to join. The Matrix team is working on a new implementation of the Matrix server written in Go called Dendrite which might perform better in low-memory environments.

Chat Server (Matrix Synapse)

What is 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. Matrix Synapse is a federated application where chat rooms can exist on any server and users from any server in the federated network can join them. Learn more about Matrix.

Available since: version 0.14.0

How to access your Matrix Synapse server?

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

Setting up Matrix Synapse on your FreedomBox

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.

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.

Memory usage

The Synapse reference server implemented in Python is known to be quite RAM hungry, especially when loading large rooms with thousands of members like #matrix:matrix.org. It is recommended to avoid joining such rooms if your FreedomBox device only has 1 GiB RAM or less. Rooms with up to a hundred members should be safe to join. The Matrix team is working on a new implementation of the Matrix server written in Go called Dendrite which might perform better in low-memory environments.

Back to Features introduction or manual pages.


Information

Support

Contribute

Reports

Promote

Overview

Hardware

Live Help

Where To Start

Translate

Calls

Talks

Features

Vision

Q&A

Design

To Do

Releases

Press

Download

Manual

Code

Contributors

Blog

FreedomBox for Communities

FreedomBox Developer Manual

HELP & DISCUSSIONS: Discussion Forum - Mailing List - #freedombox irc.debian.org | CONTACT Foundation | JOIN Project

Next call: Saturday, December 12 at 14:00 UTC

Latest news: Help translate freedombox.org - 2020-08-01

This page is copyright its contributors and is licensed under the Creative Commons Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.


CategoryFreedomBox