Matrix: Difference between revisions
Phanirithvij (talk | contribs) m edit the synapse home page (we have element-hq/synapse in nixpkgs) |
m don't link to personal blogs (see MoS) |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 3: | Line 3: | ||
This article extends the documentation in [https://nixos.org/manual/nixos/stable/#module-services-matrix NixOS manual]. | This article extends the documentation in [https://nixos.org/manual/nixos/stable/#module-services-matrix NixOS manual]. | ||
== | == Joining the community on Matrix == | ||
https://matrix.to/#/#community:nixos.org | You can read more about the different rooms on [[MatrixRooms]] and join them either from https://matrix.to/#/#community:nixos.org or directly from your client. | ||
An unofficial service provides Matrix accounts for members of the NixOS organization on GitHub: https://discourse.nixos.org/t/matrix-account-hosting-for-nix-os-hackers/14036 | |||
https://discourse.nixos.org/t/matrix-account-hosting-for-nix-os-hackers/14036 | |||
== Clients == | == Clients == | ||
| Line 15: | Line 13: | ||
=== Desktop clients === | === Desktop clients === | ||
These clients are know to work: <code>element-desktop</code> [https://element.io/] and <code>fractal</code> [https://gitlab.gnome.org/World/fractal] | |||
Most of the other clients packaged in Nixpkgs, such as <code>matrix-commander</code>, <code>neochat</code>, <code>nheko</code>, rely on the '''insecure''' and '''deprecated''' <code>olm</code> library susceptible to various security vulnerabilities.[https://nvd.nist.gov/vuln/detail/CVE-2024-45191][https://nvd.nist.gov/vuln/detail/CVE-2024-45193][https://nvd.nist.gov/vuln/detail/CVE-2024-45192] | |||
If this isn't a problem for you, you can install them as usual, and upon evaluation, Nix will helpfully guide you on how to [https://nixos.org/manual/nixpkgs/stable/#sec-allow-insecure install insecure packages]. | |||
=== Web clients === | === Web clients === | ||
There is a web version of the client [https://element.io/ Element], <code>element-web</code> on Nixpkgs, which you can use as a regular web application. See [https://nixos.org/nixos/manual/index.html#module-services-matrix-element-web the NixOS manual entry].<syntaxhighlight lang="nixos"> | |||
There is | |||
{ | { | ||
services.nginx.enable = true; | services.nginx.enable = true; | ||
| Line 69: | Line 57: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
== Homeservers == | |||
=== Conduit === | |||
<syntaxhighlight lang="nixos"> | <syntaxhighlight lang="nixos"> | ||
{ | { | ||
| Line 82: | Line 68: | ||
settings.global = { | settings.global = { | ||
# allow_registration = true; | # allow_registration = true; | ||
# You will need this token when creating your first account. | |||
# registration_token = "A S3CR3T TOKEN"; | |||
# server_name = yourDomainName; | # server_name = yourDomainName; | ||
# port = yourPort; | # port = yourPort; | ||
address = "::1"; | address = "::1"; | ||
database_backend = "rocksdb"; | database_backend = "rocksdb"; | ||
# See https:// | |||
turn_uris = [ | # See https://docs.conduit.rs/turn.html, and https://github.com/element-hq/synapse/blob/develop/docs/turn-howto.md for more details | ||
# turn_uris = [ | |||
# "turn:your.turn.url?transport=udp" | |||
]; | # "turn:your.turn.url?transport=tcp" | ||
turn_secret = " | # ]; | ||
# turn_secret = "your secret"; | |||
}; | }; | ||
}; | }; | ||
| Line 97: | Line 86: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== Synapse === | |||
[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. | [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]. | ||
<syntaxhighlight lang="nix"> | <syntaxhighlight lang="nix"> | ||
| Line 177: | Line 165: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==== Synapse with Workers ==== | |||
There's an external module to automatically set up synapse and configure nginx with workers: | There's an external module to automatically set up synapse and configure nginx with workers: | ||
https://github.com/dali99/nixos-matrix-modules | https://github.com/dali99/nixos-matrix-modules | ||
== 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. | 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 === | |||
Full configuration reference: | Full configuration reference: | ||
https://github.com/tulir/mautrix-telegram/blob/master/mautrix_telegram/example-config.yaml | https://github.com/tulir/mautrix-telegram/blob/master/mautrix_telegram/example-config.yaml | ||
| Line 266: | Line 252: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== mautrix-whatsapp === | |||
Packaged as [https://search.nixos.org/packages?query=mautrix-whatsapp mautrix-whatsapp]. | Packaged as [https://search.nixos.org/packages?query=mautrix-whatsapp mautrix-whatsapp]. | ||
Module implemented in this [https://github.com/NixOS/nixpkgs/pull/246842 PR]. | Module implemented in this [https://github.com/NixOS/nixpkgs/pull/246842 PR]. | ||
=== matrix-appservice-irc === | |||
NixOS-specific module options: TODO link to the search results once it's landed | NixOS-specific module options: TODO link to the search results once it's landed | ||
| Line 332: | Line 315: | ||
The appservice automatically creates a registration file under <code>/var/lib/matrix-appservice-irc/registration.yml</code> and keeps it up to date. If your homeserver is not located on the same machine and NixOS installation, you must absolutely make sure to synchronize that file over to the home server after each modification and keep both in sync. | The appservice automatically creates a registration file under <code>/var/lib/matrix-appservice-irc/registration.yml</code> and keeps it up to date. If your homeserver is not located on the same machine and NixOS installation, you must absolutely make sure to synchronize that file over to the home server after each modification and keep both in sync. | ||
=== matrix-appservice-discord === | |||
Full configuration reference: | Full configuration reference: | ||
https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml | https://github.com/Half-Shot/matrix-appservice-discord/blob/master/config/config.sample.yaml | ||