Matrix: Difference between revisions

(17 intermediate revisions by 9 users not shown)

Line 1:

[https://matrix.org Matrix] defines a set of open APIs for decentralised communication, suitable for securely publishing, persisting and subscribing to data over a global open federation of servers with no single point of control. Uses include Instant Messaging (IM), Voice over IP (VoIP) signalling, Internet of Things (IoT) communication, and bridging together existing communication silos - providing the basis of a new open real-time communication ecosystem.

This article extends the documentation in [https://nixos.org/manual/nixos/stable/#module-services-matrix NixOS manual].

== NixOS Matrix channels ==

Line 18:

Line 20:

* [https://search.nixos.org/packages?query=fractal Fractal]

* [https://search.nixos.org/packages?query=gomuks gomuks]

* [https://search.nixos.org/packages?query=~~matrique matrique~~]

* [https://search.nixos.org/packages?query=neochat neochat]

* [https://search.nixos.org/packages?query=mirage-im Mirage]

* [https://search.nixos.org/packages?query=nheko nheko]

* [https://search.nixos.org/packages?query=quaternion Quaternion]

* [https://search.nixos.org/packages?query=iamb iamb]

A [https://search.nixos.org/packages?query=purple-matrix Pidgin / libpurple plugin] is also available.

Line 27:

Line 30:

=== Web clients ===

There is also a web version of [https://search.nixos.org/packages?query=element-web Element] which can be served using a web server. See [https://nixos.org/nixos/manual/index.html#module-services-matrix-element-web the NixOS manual entry].

==== element-web ====

There is also a web version of [https://search.nixos.org/packages?query=element-web Element] which can be served using a web server. See [https://nixos.org/nixos/manual/index.html#module-services-matrix-element-web the NixOS manual entry].<syntaxhighlight lang="nixos">

{

services.nginx.enable = true;

# See https://nixos.org/manual/nixos/stable/index.html#module-services-matrix-element-web

services.nginx.virtualHosts."localhost" = {

listen = [{

addr = "[::1]";

port = yourPort;

}];

root = pkgs.element-web.override {

# See https://github.com/element-hq/element-web/blob/develop/config.sample.json

conf = {

default_theme = "dark";

};

}

</syntaxhighlight>Alternatively, you can write a script to start the web client on demand.<syntaxhighlight lang="nix">

let

# port = yourPort;

web-dir = pkgs.element-web.override {

conf = {

default_theme = "dark";

show_labs_settings = true;

};

element-web = pkgs.writeScriptBin "element-web" ''

#!${pkgs.bash}/bin/bash

set -e

${pkgs.python3}/bin/python3 -m http.server ${port} -b ::1 -d ${web-dir}

'';

in

{

home.sessionPath = [ "${element-web}/bin" ];

}

</syntaxhighlight>

== Servers ==

=== Homeservers ===

==== Conduit ====

{

# See https://search.nixos.org/options?channel=unstable&query=services.matrix-conduit.

# and https://docs.conduit.rs/configuration.html

services.matrix-conduit = {

enable = true;

settings.global = {

# allow_registration = true;

# server_name = yourDomainName;

# port = yourPort;

address = "::1";

database_backend = "rocksdb";

# See https://www.metered.ca/tools/openrelay

turn_uris = [

"turn:staticauth.openrelay.metered.ca:80?transport=udp"

"turn:staticauth.openrelay.metered.ca:80?transport=tcp"

];

turn_secret = "openrelayprojectsecret";

};

}

</syntaxhighlight>

==== Synapse ====

~~Currently, only the reference Matrix homeserver~~ [https://~~matrix~~.~~org/docs/projects/server~~/synapse ~~Synapse] is [https:~~//~~search~~.~~nixos.org/packages?query=matrix-synapse packaged~~] ~~for NixOS. It~~ has an associated module exposing the [https://search.nixos.org/options?query=services.matrix-synapse services.matrix-synapse.* options]. See [https://nixos.org/nixos/manual/index.html#module-services-matrix-synapse the NixOS manual entry] for a complete configuration example.

[https://element-hq.github.io/synapse/latest/welcome_and_overview.html Synapse] has an associated module exposing the [https://search.nixos.org/options?query=services.matrix-synapse services.matrix-synapse.* options]. See [https://nixos.org/nixos/manual/index.html#module-services-matrix-synapse the NixOS manual entry] for a complete configuration example.

===== Coturn with Synapse =====

For WebRTC calls to work when both callers are behind a NAT, you need to provide a turn server for clients to use. Here is an example configuration, inspired from [https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/roles/matrix-coturn/templates/turnserver.conf.j2 this configuration file].

For WebRTC calls to work when both callers are behind a NAT, you need to provide a turn server for clients to use. Here is an example configuration, inspired from [https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/master/roles/custom/matrix-coturn/templates/turnserver.conf.j2 this configuration file].

Line 86:

Line 150:

networking.firewall = {

interfaces.enp2s0 = let

range = with config.services.coturn; [ {

range = with config.services.coturn; lib.singleton {

from = min-port;

to = max-port;

} ];

};

in

{

Line 105:

Line 169:

};

# configure synapse to point users to coturn

services.matrix-synapse = with config.services.coturn; {

services.matrix-synapse.settings = with config.services.coturn; {

turn_uris = ["turn:${realm}:3478?transport=udp" "turn:${realm}:3478?transport=tcp"];

turn_shared_secret = static-auth-secret;

Line 118:

Line 182:

=== Application services (a.k.a. bridges) ===

Bridges allow you to connect Matrix to a third-party platform (like Discord, Telegram, etc.), and interact seamlessly. See [https://matrix.org/ecosystem/bridges/ here] for a list of currently supported bridges.

==== mautrix-telegram ====

Line 204:

Line 270:

Packaged as [https://search.nixos.org/packages?query=mautrix-whatsapp mautrix-whatsapp].

[https://github.com/NixOS/nixpkgs/pull/~~59211 Module still a WIP~~].

Module implemented in this [https://github.com/NixOS/nixpkgs/pull/246842 PR].

==== matrix-appservice-irc ====

Line 312:

Line 378:

== See also ==

* [[Mjolnir]] - a Matrix moderation tool

* [~~https://nixos.org/nixos/manual/index.html#module~~-~~services-matrix The chapter about~~ Matrix ~~in the NixOS manual]~~

* [https://matrix.to/#/!vxTmkuJzhGPsMdkAOc:transformierende-gesellschaft.org?via=transformierende-gesellschaft.org The Nix Matrix Subsystem chat room, on Matrix]

[[Category:Applications]]

[[Category:Server]]

[[Category:NixOS Manual]]