Mautrix signal

services.mautrix-signal.enable

Whether to enable mautrix-signal, a Matrix-Signal puppeting bridge. Type: boolean

Default

false

Example

true

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

services.mautrix-signal.environmentFile

File containing environment variables to be passed to the mautrix-signal service. If an environment variable MAUTRIX_SIGNAL_BRIDGE_LOGIN_SHARED_SECRET is set, then its value will be used in the configuration file for the option login_shared_secret_map without leaking it to the store, using the configured homeserver.domain as key. See here for the documentation of login_shared_secret_map.

Type: null or path

Default

null

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

services.mautrix-signal.registerToSynapse

Whether to add the bridge's app service registration file to services.matrix-synapse.settings.app_service_config_files.

Type: boolean

Default

config.services.matrix-synapse.enable

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

services.mautrix-signal.serviceDependencies

List of systemd units 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.serviceUnit)++ (optional config.services.matrix-conduit.enable "conduit.service")

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

services.mautrix-signal.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 = "Signal Bridge Bot";username = "signalbot";};database = {type = "sqlite3";uri = "file:/var/lib/mautrix-signal/mautrix-signal.db?_txlock=immediate";};hostname = "[::]";hs_token = "";id = "signal";port = 29328;};bridge = {command_prefix = "!signal";displayname_template = "{{or .ProfileName .PhoneNumber \"Unknown user\"}}";double_puppet_server_map = { };login_shared_secret_map = { };permissions = {"*" = "relay";};relay = {enabled = true;};username_template = "signal_{{.}}";};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_signal?host=/run/postgresql";};ephemeral_events = false;id = "signal";};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-signal.nix