Matrix: Difference between revisions
m (Minor grammar tweaks, remove redundant hyperlink; replaced 2nd instance of aforementioned hyperlink with wikilink.) |
(Added synapse install documentation) |
||
| Line 15: | Line 15: | ||
{{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}} | {{tip|Detailed information is found in [[Include:Upgrading_to_latest_release|this]] doc.}} | ||
= | = Matrix Synapse server = | ||
This Wiki will cover the configuration and setup of the Synapse server, as this is the most commonly used and feature complete Matrix Protocol server at this time. | This Wiki will cover the installation, configuration, and setup of the '''Matrix Synapse server''', as this is the most commonly used and feature complete Matrix Protocol server at this time. | ||
== Install Matrix Synapse server == | |||
Synapse package is available in the Alpine Linux repositories. To install it run: | |||
{{Cmd|apk update | |||
apk add synapse}} | |||
When installing the Alpine Linux synapse package, it will create a user called ''synapse''. | |||
== Configuration and Setup == | |||
During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at {{path|/etc/synapse/homeserver.conf}}. | |||
Revision as of 15:03, 19 July 2024
Matrix is an ambitious new ecosystem and protocol for open federated instant messaging and VoIP. It consists of servers, various clients and bridge software to connect to existing messaging solutions such as IRC (Internet Relay Chat).
The Alpine Linux IRC chatrooms are bridged to Matrix. The General Alpine Linux room can be found on Matrix here #_oftc_#alpine-linux:matrix.org. If you want to access any of the other Alpine Linux chats from Matrix, then substitute the IRC channel name accordingly.
Installation
The Matrix Protocol has multiple server implementations which are available on Alpine Linux.
The reference server implementation Synapse, which is the most commonly used server, is available as the synapse package. It has been available since Alpine 3.11.
There is also a second-generation Matrix homeserver written in Go, which is available as the dendrite package. It intends to provide an efficient, reliable and scalable alternative to Synapse, but it is not as feature complete as Synapse is at this time. It has been available since Alpine 3.15.
There is also another Matrix homeserver, written in Rust, which is available as the conduit package and is only currently available in the Alpine Edge at this time.
Before you start installing anything, make sure you have the latest packages available.
Matrix Synapse server
This Wiki will cover the installation, configuration, and setup of the Matrix Synapse server, as this is the most commonly used and feature complete Matrix Protocol server at this time.
Install Matrix Synapse server
Synapse package is available in the Alpine Linux repositories. To install it run:
apk update apk add synapse
When installing the Alpine Linux synapse package, it will create a user called synapse.
Configuration and Setup
During installation, the Alpine Linux synapse package will create a default synapse configuration file which will be located at /etc/synapse/homeserver.conf.