diff --git a/modules/kabbone/mautrix-whatsapp.md b/modules/kabbone/mautrix-whatsapp.md index da65964..751dcf1 100644 --- a/modules/kabbone/mautrix-whatsapp.md +++ b/modules/kabbone/mautrix-whatsapp.md @@ -1,32 +1,32 @@ -# Mautrix-Signal {#module-services-mautrix-signal} +# Mautrix-Whatsapp {#module-services-mautrix-whatsapp} -[Mautrix-Signal](https://github.com/mautrix/signal) is a Matrix-Signal puppeting bridge. +[Mautrix-Whatsapp](https://github.com/mautrix/whatsapp) is a Matrix-Whatsapp puppeting bridge. -## Configuration {#module-services-mautrix-signal-configuration} +## Configuration {#module-services-mautrix-whatsapp-configuration} -1. Set [](#opt-services.mautrix-signal.enable) to `true`. The service will use +1. Set [](#opt-services.mautrix-whatsapp.enable) to `true`. The service will use SQLite by default. 2. To create your configuration check the default configuration for - [](#opt-services.mautrix-signal.settings). To obtain the complete default + [](#opt-services.mautrix-whatsapp.settings). To obtain the complete default configuration, run - `nix-shell -p mautrix-signal --run "mautrix-signal -c default.yaml -e"`. + `nix-shell -p mautrix-whatsapp --run "mautrix-whatsapp -c default.yaml -e"`. ::: {.warning} -Mautrix-Signal allows for some options like `encryption.pickle_key`, +Mautrix-Whatsapp allows for some options like `encryption.pickle_key`, `provisioning.shared_secret`, allow the value `generate` to be set. Since the configuration file is regenerated on every start of the service, the generated values would be discarded and might break your installation. Instead, set those values via -[](#opt-services.mautrix-signal.environmentFile). +[](#opt-services.mautrix-whatsapp.environmentFile). ::: -## Migrating from an older configuration {#module-services-mautrix-signal-migrate-configuration} +## Migrating from an older configuration {#module-services-mautrix-whatsapp-migrate-configuration} -With Mautrix-Signal v0.7.0 the configuration has been rearranged. Mautrix-Signal +With Mautrix-Whatsapp v0.7.0 the configuration has been rearranged. Mautrix-Whatsapp performs an automatic configuration migration so your pre-0.7.0 configuration should just continue to work. In case you want to update your NixOS configuration, compare the migrated configuration -at `/var/lib/mautrix-signal/config.yaml` with the default configuration -(`nix-shell -p mautrix-signal --run "mautrix-signal -c example.yaml -e"`) and +at `/var/lib/mautrix-whatsapp/config.yaml` with the default configuration +(`nix-shell -p mautrix-whatsapp --run "mautrix-whatsapp -c example.yaml -e"`) and update your module configuration accordingly. diff --git a/modules/kabbone/mautrix-whatsapp.nix b/modules/kabbone/mautrix-whatsapp.nix index 508c93b..446d89a 100644 --- a/modules/kabbone/mautrix-whatsapp.nix +++ b/modules/kabbone/mautrix-whatsapp.nix @@ -271,8 +271,8 @@ in }; }; meta = { - buildDocsInSandbox = false; - doc = ./mautrix-whatsapp.md; + #buildDocsInSandbox = false; + #doc = ./mautrix-whatsapp.md; maintainers = with lib.maintainers; [ kabbone ];