commit 6e5554c44c2c70bea1e25e350f8153608972a672 · pyrox.dev/nixpkgs

nixos/doc/manual/redirects.json

···

       1178
       1178
        
         "module-services-mautrix-signal-migrate-configuration": [

     

       1179
       1179
        
           "index.html#module-services-mautrix-signal-migrate-configuration"

     

       1180
       1180
        
         ],

     

       1181
       1181
       +
         "module-services-mautrix-whatsapp": [

     

       1182
       1182
       +
           "index.html#module-services-mautrix-whatsapp"

     

       1183
       1183
       +
         ],

     

       1184
       1184
       +
         "module-services-mautrix-whatsapp-configuration": [

     

       1185
       1185
       +
           "index.html#module-services-mautrix-whatsapp-configuration"

     

       1186
       1186
       +
         ],

     

       1187
       1187
       +
         "module-services-mautrix-whatsapp-migrate-configuration": [

     

       1188
       1188
       +
           "index.html#module-services-mautrix-whatsapp-migrate-configuration"

     

       1189
       1189
       +
         ],

     

       1181
       1190
        
         "module-services-maubot": [

     

       1182
       1191
        
           "index.html#module-services-maubot"

     

       1183
       1192
        
         ],

+32

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

···

       1
       1
       +
       # Mautrix-Whatsapp {#module-services-mautrix-whatsapp}

     

       2
       2
       +
       

     

       3
       3
       +
       [Mautrix-Whatsapp](https://github.com/mautrix/whatsapp) is a Matrix-Whatsapp puppeting bridge.

     

       4
       4
       +
       

     

       5
       5
       +
       ## Configuration {#module-services-mautrix-whatsapp-configuration}

     

       6
       6
       +
       

     

       7
       7
       +
       1. Set [](#opt-services.mautrix-whatsapp.enable) to `true`. The service will use

     

       8
       8
       +
          SQLite by default.

     

       9
       9
       +
       2. To create your configuration check the default configuration for

     

       10
       10
       +
          [](#opt-services.mautrix-whatsapp.settings). To obtain the complete default

     

       11
       11
       +
          configuration, run

     

       12
       12
       +
          `nix-shell -p mautrix-whatsapp --run "mautrix-whatsapp -c default.yaml -e"`.

     

       13
       13
       +
       

     

       14
       14
       +
       ::: {.warning}

     

       15
       15
       +
       Mautrix-Whatsapp allows for some options like `encryption.pickle_key`,

     

       16
       16
       +
       `provisioning.shared_secret`, allow the value `generate` to be set.

     

       17
       17
       +
       Since the configuration file is regenerated on every start of the

     

       18
       18
       +
       service, the generated values would be discarded and might break your

     

       19
       19
       +
       installation. Instead, set those values via

     

       20
       20
       +
       [](#opt-services.mautrix-whatsapp.environmentFile).

     

       21
       21
       +
       :::

     

       22
       22
       +
       

     

       23
       23
       +
       ## Migrating from an older configuration {#module-services-mautrix-whatsapp-migrate-configuration}

     

       24
       24
       +
       

     

       25
       25
       +
       With Mautrix-Whatsapp v0.11.0 the configuration has been rearranged. Mautrix-Whatsapp

     

       26
       26
       +
       performs an automatic configuration migration so your pre-0.7.0 configuration

     

       27
       27
       +
       should just continue to work.

     

       28
       28
       +
       

     

       29
       29
       +
       In case you want to update your NixOS configuration, compare the migrated configuration

     

       30
       30
       +
       at `/var/lib/mautrix-whatsapp/config.yaml` with the default configuration

     

       31
       31
       +
       (`nix-shell -p mautrix-whatsapp --run "mautrix-whatsapp -c example.yaml -e"`) and

     

       32
       32
       +
       update your module configuration accordingly.