nixos/modules/services/matrix/mautrix-signal.md

   1 # Mautrix-Signal {#module-services-mautrix-signal}
   2
   3 [Mautrix-Signal](https://github.com/mautrix/signal) is a Matrix-Signal puppeting bridge.
   4
   5 ## Configuration {#module-services-mautrix-signal-configuration}
   6
   7 1. Set [](#opt-services.mautrix-signal.enable) to `true`. The service will use
   8    SQLite by default.
   9 2. To create your configuration check the default configuration for
  10    [](#opt-services.mautrix-signal.settings). To obtain the complete default
  11    configuration, run
  12    `nix-shell -p mautrix-signal --run "mautrix-signal -c default.yaml -e"`.
  13
  14 ::: {.warning}
  15 Mautrix-Signal allows for some options like `encryption.pickle_key`,
  16 `provisioning.shared_secret`, allow the value `generate` to be set.
  17 Since the configuration file is regenerated on every start of the
  18 service, the generated values would be discarded and might break your
  19 installation. Instead, set those values via
  20 [](#opt-services.mautrix-signal.environmentFile).
  21 :::
  22
  23 ## Migrating from an older configuration {#module-services-mautrix-signal-migrate-configuration}
  24
  25 With Mautrix-Signal v0.7.0 the configuration has been rearranged. Mautrix-Signal
  26 performs an automatic configuration migration so your pre-0.7.0 configuration
  27 should just continue to work.
  28
  29 In case you want to update your NixOS configuration, compare the migrated configuration
  30 at `/var/lib/mautrix-signal/config.yaml` with the default configuration
  31 (`nix-shell -p mautrix-signal --run "mautrix-signal -c example.yaml -e"`) and
  32 update your module configuration accordingly.