Mautrix whatsapp

services.mautrix-whatsapp.enable

Whether to enable mautrix-whatsapp, a puppeting/relaybot bridge between Matrix and WhatsApp. Type: boolean

Default

false

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/mautrix-whatsapp.nix

services.mautrix-whatsapp.environmentFile

File containing environment variables to be passed to the mautrix-whatsapp service, in which secret tokens can be specified securely by optionally defining a value for MAUTRIX_WHATSAPP_BRIDGE_LOGIN_SHARED_SECRET.

Type: null or path

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/mautrix-whatsapp.nix

services.mautrix-whatsapp.serviceDependencies

List of Systemd services to require and wait for when starting the application service.

Type: list of string

Default

optional config.services.matrix-synapse.enable config.services.matrix-synapse.serviceUnits

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/mautrix-whatsapp.nix

services.mautrix-whatsapp.settings

{file}config.yaml configuration as a Nix attribute set. Configuration options should match those described in example-config.yaml. Secret tokens should be specified using {option}environmentFile instead of this world-readable attribute set.

Type: JSON value

Default

{appservice = {as_token = "";bot = {displayname = "WhatsApp Bridge Bot";username = "whatsappbot";};database = {type = "sqlite3";uri = "/var/lib/mautrix-whatsapp/mautrix-whatsapp.db";};hostname = "[::]";hs_token = "";id = "whatsapp";port = 29318;};bridge = {command_prefix = "!wa";displayname_template = "{{if .BusinessName}}{{.BusinessName}}{{else if .PushName}}{{.PushName}}{{else}}{{.JID}}{{end}} (WA)";double_puppet_server_map = { };login_shared_secret_map = { };permissions = {"*" = "relay";};relay = {enabled = true;};username_template = "whatsapp_{{.}}";};homeserver = {address = "http://localhost:8448";};logging = {min_level = "info";writers = [{format = "pretty-colored";time_format = " ";type = "stdout";}];};}

Example

{appservice = {database = {type = "postgres";uri = "postgresql:///mautrix_whatsapp?host=/run/postgresql";};ephemeral_events = false;id = "whatsapp";};bridge = {encryption = {allow = true;default = true;require = true;};history_sync = {request_full_sync = true;};mute_bridging = true;permissions = {"example.com" = "user";};private_chat_portal_meta = true;provisioning = {shared_secret = "disable";};};}

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/matrix/mautrix-whatsapp.nix