From 2d5d86ff5263fc9f003277d28863347a0c7c01fc Mon Sep 17 00:00:00 2001 From: Sebastian Hugentobler Date: Thu, 18 Aug 2022 11:37:51 +0200 Subject: [PATCH] update configuration file --- rootfs/etc/confd/templates/config.yaml.tmpl | 58 ++++++++++++--------- 1 file changed, 34 insertions(+), 24 deletions(-) diff --git a/rootfs/etc/confd/templates/config.yaml.tmpl b/rootfs/etc/confd/templates/config.yaml.tmpl index fe5f20f..2412d25 100644 --- a/rootfs/etc/confd/templates/config.yaml.tmpl +++ b/rootfs/etc/confd/templates/config.yaml.tmpl @@ -28,10 +28,14 @@ appservice: # Database config. database: - # The database type. Only "sqlite3" is supported. + # The database type. "sqlite3" and "postgres" are supported. type: postgres - # The database URI. Usually file name. https://github.com/mattn/go-sqlite3#connection-string - uri: {{ getenv "DATABASE_DATASOURCE" }} + # The database URI. + # SQLite: File name is enough. https://github.com/mattn/go-sqlite3#connection-string + # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable + # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql + uri: {{ getenv "DATABASE_DATASOURCE" }} + # Maximum number of connections. Mostly relevant for Postgres. max_open_conns: 20 max_idle_conns: 2 # Maximum connection idle time and lifetime before they're closed. Disabled if null. @@ -50,15 +54,17 @@ appservice: displayname: WhatsApp bridge bot avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr - # Whether or not to receive ephemeral events via appservice transactions. # Requires MSC2409 support (i.e. Synapse 1.22+). # You should disable bridge -> sync_with_custom_puppets when this is enabled. ephemeral_events: false # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. - as_token: "{{ getenv "AS_TOKEN" }}" - hs_token: "{{ getenv "HS_TOKEN" }}" + as_token: "{{ getenv "AS_TOKEN" -}}" + hs_token: "{{ getenv "HS_TOKEN" -}}" + +# Segment API key to track some events, like provisioning API login and encryption errors. +segment_key: null # Prometheus config. metrics: @@ -73,15 +79,22 @@ whatsapp: os_name: Mautrix-WhatsApp bridge # Browser name that determines the logo shown in the mobile app. # Must be "unknown" for a generic icon or a valid browser name if you want a specific icon. - # List of valid browser names: https://github.com/tulir/whatsmeow/blob/2a72655ef600a7fd7a2e98d53ec6da029759c4b8/binary/proto/def.proto#L1582-L1594 + # List of valid browser names: https://github.com/tulir/whatsmeow/blob/8b34d886d543b72e5f4699cf5b2797f68d598f78/binary/proto/def.proto#L38-L51 browser_name: unknown -# Bridge config +# Bridge config bridge: # Localpart template of MXIDs for WhatsApp users. + # {{"{{"}}.{{"}}}} is replaced with the phone number of the WhatsApp user. username_template: whatsapp_{{"{{"}}.{{"}}"}} # Displayname template for WhatsApp users. - displayname_template: "{{"{{"}}if .PushName{{"}}"}}{{"{{"}}.PushName{{"}}"}}{{"{{"}}else if .BusinessName{{"}}"}}{{"{{"}}.BusinessName{{"}}"}}{{"{{"}}else{{"}}"}}{{"{{"}}.JID{{"}}"}}{{"{{"}}end{{"}}"}} (WA)" + # {{"{{"}}.PushName{{"}}"}} - nickname set by the WhatsApp user + # {{"{{"}}.BusinessName{{"}}"}} - validated WhatsApp business name + # {{"{{".Phone"}}"}} - phone number (international format) + # The following variables are also available, but will cause problems on multi-user instances: + # {{"{{"}}.FullName{{"}}"}} - full name from contact list + # {{"{{"}}.FirstName{{"}}"}} - first name from contact list + displayname_template: "{{"{{"}}if .PushName{{"}}"}}{{"{{"}}.PushName{{"}}"}}{{"{{"}}else if .BusinessName{{"}}"}}{{"{{"}}.BusinessName{{"}}"}}{{"{{"}}else{{"}}"}}{{"{{"}}.JID{{"}}"}}{{"{{"}}end{{"}}"}} (WA)" # Should the bridge create a space for each logged-in user and add bridged rooms to it? # Users who logged in before turning this on should run `!wa sync space` to create and fill the space for the first time. personal_filtering_spaces: false @@ -96,11 +109,9 @@ bridge: # Should another user's cryptographic identity changing send a message to Matrix? identity_change_notices: false portal_message_buffer: 128 - # Settings for handling history sync payloads. These settings only apply right after login, - # because the phone only sends the history sync data once, and there's no way to re-request it - # (other than logging out and back in again). + # Settings for handling history sync payloads. history_sync: - # Should the bridge create portals for chats in the history sync payload? + # Should the bridge create portals for chats in the history sync payload? create_portals: true # Enable backfilling history sync payloads from WhatsApp using batch sending? # This requires a server with MSC2716 support, which is currently an experimental feature in synapse. @@ -242,7 +253,7 @@ bridge: # This can cause issues if the user has lots of contacts, so it's disabled by default. disable_status_broadcast_send: true # Should the status broadcast room be muted and moved into low priority by default? - # This is only applied when creating the room, the user can unmute/untag it later. + # This is only applied when creating the room, the user can unmute it later. mute_status_broadcast: true # Tag to apply to the status broadcast room. status_broadcast_tag: m.lowpriority @@ -283,7 +294,6 @@ bridge: # The prefix for commands. Only required in non-management rooms. command_prefix: "!wa" - # Messages sent upon joining a management room. # Markdown is supported. The defaults are listed below. management_room_text: @@ -345,17 +355,18 @@ bridge: # session before changing it. The Matrix spec recommends 100 as the # default. messages: 100 - - # Settings for provisioning API - provisioning: - # Prefix for the provisioning API paths. - prefix: /_matrix/provision - # Shared secret for authentication. If set to "generate", a random secret will be generated, - # or if set to "disable", the provisioning API will be disabled. - shared_secret: generate + + # Settings for provisioning API + provisioning: + # Prefix for the provisioning API paths. + prefix: /_matrix/provision + # Shared secret for authentication. If set to "generate", a random secret will be generated, + # or if set to "disable", the provisioning API will be disabled. + shared_secret: generate # Permissions for using the bridge. # Permitted values: + # relay - Talk through the relaybot (if enabled), no access otherwise # user - Access to use the bridge to chat with a WhatsApp account. # admin - User level and some additional administration tools # Permitted keys: @@ -401,4 +412,3 @@ logging: # Minimum severity for log messages printed to stdout/stderr. This doesn't affect the log file. # Options: debug, info, warn, error, fatal print_level: debug -