Kabbone/nixos-config
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

kabbone_mautrix-whatsapp disable doc for now

Browse Source
This commit is contained in:
Kabbone 2025-05-28 14:07:05 +02:00
parent 671e3db9cf
commit 69733fa69a
Signed by: Kabbone
SSH Key Fingerprint: SHA256:A5zPB5I6u5V78V51c362BBdCwhDhfDUVbt7NfKdjWBY
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
modules/kabbone/mautrix-whatsapp.md
View File

@ -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. SQLite by default.
2. To create your configuration check the default configuration for 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 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} ::: {.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. `provisioning.shared_secret`, allow the value `generate` to be set.
Since the configuration file is regenerated on every start of the Since the configuration file is regenerated on every start of the
service, the generated values would be discarded and might break your service, the generated values would be discarded and might break your
installation. Instead, set those values via 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 performs an automatic configuration migration so your pre-0.7.0 configuration
should just continue to work. should just continue to work.
In case you want to update your NixOS configuration, compare the migrated configuration In case you want to update your NixOS configuration, compare the migrated configuration
at `/var/lib/mautrix-signal/config.yaml` with the default configuration at `/var/lib/mautrix-whatsapp/config.yaml` with the default configuration
(`nix-shell -p mautrix-signal --run "mautrix-signal -c example.yaml -e"`) and (`nix-shell -p mautrix-whatsapp --run "mautrix-whatsapp -c example.yaml -e"`) and
update your module configuration accordingly. update your module configuration accordingly.

4
modules/kabbone/mautrix-whatsapp.nix
View File

@ -271,8 +271,8 @@ in
}; };
}; };
meta = { meta = {
buildDocsInSandbox = false; #buildDocsInSandbox = false;
doc = ./mautrix-whatsapp.md; #doc = ./mautrix-whatsapp.md;
maintainers = with lib.maintainers; [ maintainers = with lib.maintainers; [
kabbone kabbone
]; ];