Matrix Docker Ansible eploy
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 

521 lines
30 KiB

  1. #jinja2: lstrip_blocks: "True"
  2. # Network-specific config options
  3. network:
  4. # Device name that's shown in the "WhatsApp Web" section in the mobile app.
  5. os_name: Mautrix-WhatsApp bridge
  6. # Browser name that determines the logo shown in the mobile app.
  7. # Must be "unknown" for a generic icon or a valid browser name if you want a specific icon.
  8. # List of valid browser names: https://github.com/tulir/whatsmeow/blob/efc632c008604016ddde63bfcfca8de4e5304da9/binary/proto/def.proto#L43-L64
  9. browser_name: unknown
  10. # Proxy to use for all WhatsApp connections.
  11. proxy: null
  12. # Alternative to proxy: an HTTP endpoint that returns the proxy URL to use for WhatsApp connections.
  13. get_proxy_url: null
  14. # Whether the proxy options should only apply to the login websocket and not to authenticated connections.
  15. proxy_only_login: false
  16. # Displayname template for WhatsApp users.
  17. # {% raw %}
  18. # {{.PushName}} - nickname set by the WhatsApp user
  19. # {{.BusinessName}} - validated WhatsApp business name
  20. # {{.Phone}} - phone number (international format)
  21. # {{.FullName}} - Name you set in the contacts list
  22. # {% endraw %}
  23. displayname_template: "{% raw %}{{or .BusinessName .PushName .Phone}} (WA){% endraw %}"
  24. # Should incoming calls send a message to the Matrix room?
  25. call_start_notices: true
  26. # Should another user's cryptographic identity changing send a message to Matrix?
  27. identity_change_notices: false
  28. # Send the presence as "available" to whatsapp when users start typing on a portal.
  29. # This works as a workaround for homeservers that do not support presence, and allows
  30. # users to see when the whatsapp user on the other side is typing during a conversation.
  31. send_presence_on_typing: false
  32. # Should WhatsApp status messages be bridged into a Matrix room?
  33. # Disabling this won't affect already created status broadcast rooms.
  34. enable_status_broadcast: {{ matrix_mautrix_whatsapp_bridge_enable_status_broadcast | to_json }}
  35. # Should sending WhatsApp status messages be allowed?
  36. # This can cause issues if the user has lots of contacts, so it's disabled by default.
  37. disable_status_broadcast_send: true
  38. # Should the status broadcast room be muted and moved into low priority by default?
  39. # This is only applied when creating the room, the user can unmute it later.
  40. mute_status_broadcast: true
  41. # Tag to apply to the status broadcast room.
  42. status_broadcast_tag: m.lowpriority
  43. # Should the bridge use thumbnails from WhatsApp?
  44. # They're disabled by default due to very low resolution.
  45. whatsapp_thumbnail: false
  46. # Should the bridge detect URLs in outgoing messages, ask the homeserver to generate a preview,
  47. # and send it to WhatsApp? URL previews can always be sent using the `com.beeper.linkpreviews`
  48. # key in the event content even if this is disabled.
  49. url_previews: false
  50. # Should polls be sent using unstable MSC3381 event types?
  51. extev_polls: {{ matrix_mautrix_whatsapp_extev_polls | to_json }}
  52. # Should view-once messages be disabled entirely?
  53. disable_view_once: false
  54. # Should the bridge always send "active" delivery receipts (two gray ticks on WhatsApp)
  55. # even if the user isn't marked as online (e.g. when presence bridging isn't enabled)?
  56. #
  57. # By default, the bridge acts like WhatsApp web, which only sends active delivery
  58. # receipts when it's in the foreground.
  59. force_active_delivery_receipts: false
  60. # Settings for converting animated stickers.
  61. animated_sticker:
  62. # Format to which animated stickers should be converted.
  63. # disable - No conversion, just unzip and send raw lottie JSON
  64. # png - converts to non-animated png (fastest)
  65. # gif - converts to animated gif
  66. # webm - converts to webm video, requires ffmpeg executable with vp9 codec and webm container support
  67. # webp - converts to animated webp, requires ffmpeg executable with webp codec/container support
  68. target: webp
  69. # Arguments for converter. All converters take width and height.
  70. args:
  71. width: 320
  72. height: 320
  73. fps: 25 # only for webm, webp and gif (2, 5, 10, 20 or 25 recommended)
  74. # Settings for handling history sync payloads.
  75. history_sync:
  76. # How many conversations should the bridge create after login?
  77. # If -1, all conversations received from history sync will be bridged.
  78. # Other conversations will be backfilled on demand when receiving a message.
  79. max_initial_conversations: -1
  80. # Should the bridge request a full sync from the phone when logging in?
  81. # This bumps the size of history syncs from 3 months to 1 year.
  82. request_full_sync: false
  83. # Configuration parameters that are sent to the phone along with the request full sync flag.
  84. # By default, (when the values are null or 0), the config isn't sent at all.
  85. full_sync_config:
  86. # Number of days of history to request.
  87. # The limit seems to be around 3 years, but using higher values doesn't break.
  88. days_limit: null
  89. # This is presumably the maximum size of the transferred history sync blob, which may affect what the phone includes in the blob.
  90. size_mb_limit: null
  91. # This is presumably the local storage quota, which may affect what the phone includes in the history sync blob.
  92. storage_quota_mb: null
  93. # Settings for media requests. If the media expired, then it will not be on the WA servers.
  94. # Media can always be requested by reacting with the ♻ (recycle) emoji.
  95. # These settings determine if the media requests should be done automatically during or after backfill.
  96. media_requests:
  97. # Should the expired media be automatically requested from the server as part of the backfill process?
  98. auto_request_media: true
  99. # Whether to request the media immediately after the media message is backfilled ("immediate")
  100. # or at a specific time of the day ("local_time").
  101. request_method: immediate
  102. # If request_method is "local_time", what time should the requests be sent (in minutes after midnight)?
  103. request_local_time: 120
  104. # Maximum number of media request responses to handle in parallel per user.
  105. max_async_handle: 2
  106. # Config options that affect the central bridge module.
  107. bridge:
  108. # The prefix for commands. Only required in non-management rooms.
  109. command_prefix: {{ matrix_mautrix_whatsapp_command_prefix | to_json }}
  110. # Should the bridge create a space for each login containing the rooms that account is in?
  111. personal_filtering_spaces: {{ matrix_mautrix_whatsapp_bridge_personal_filtering_spaces | to_json }}
  112. # Whether the bridge should set names and avatars explicitly for DM portals.
  113. # This is only necessary when using clients that don't support MSC4171.
  114. private_chat_portal_meta: true
  115. # Should events be handled asynchronously within portal rooms?
  116. # If true, events may end up being out of order, but slow events won't block other ones.
  117. # This is not yet safe to use.
  118. async_events: false
  119. # Should every user have their own portals rather than sharing them?
  120. # By default, users who are in the same group on the remote network will be
  121. # in the same Matrix room bridged to that group. If this is set to true,
  122. # every user will get their own Matrix room instead.
  123. split_portals: false
  124. # Should the bridge resend `m.bridge` events to all portals on startup?
  125. resend_bridge_info: false
  126. # Should leaving Matrix rooms be bridged as leaving groups on the remote network?
  127. bridge_matrix_leave: false
  128. # Should room tags only be synced when creating the portal? Tags mean things like favorite/pin and archive/low priority.
  129. # Tags currently can't be synced back to the remote network, so a continuous sync means tagging from Matrix will be undone.
  130. tag_only_on_create: true
  131. # Should room mute status only be synced when creating the portal?
  132. # Like tags, mutes can't currently be synced back to the remote network.
  133. mute_only_on_create: true
  134. # What should be done to portal rooms when a user logs out or is logged out?
  135. # Permitted values:
  136. # nothing - Do nothing, let the user stay in the portals
  137. # kick - Remove the user from the portal rooms, but don't delete them
  138. # unbridge - Remove all ghosts in the room and disassociate it from the remote chat
  139. # delete - Remove all ghosts and users from the room (i.e. delete it)
  140. cleanup_on_logout:
  141. # Should cleanup on logout be enabled at all?
  142. enabled: false
  143. # Settings for manual logouts (explicitly initiated by the Matrix user)
  144. manual:
  145. # Action for private portals which will never be shared with other Matrix users.
  146. private: nothing
  147. # Action for portals with a relay user configured.
  148. relayed: nothing
  149. # Action for portals which may be shared, but don't currently have any other Matrix users.
  150. shared_no_users: nothing
  151. # Action for portals which have other logged-in Matrix users.
  152. shared_has_users: nothing
  153. # Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
  154. # Keys have the same meanings as in the manual section.
  155. bad_credentials:
  156. private: nothing
  157. relayed: nothing
  158. shared_no_users: nothing
  159. shared_has_users: nothing
  160. # Settings for relay mode
  161. relay:
  162. # Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
  163. # authenticated user into a relaybot for that chat.
  164. enabled: {{ matrix_mautrix_whatsapp_bridge_relay_enabled | to_json }}
  165. # Should only admins be allowed to set themselves as relay users?
  166. # If true, non-admins can only set users listed in default_relays as relays in a room.
  167. admin_only: {{ matrix_mautrix_whatsapp_bridge_relay_admin_only | to_json }}
  168. # List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
  169. default_relays: {{ matrix_mautrix_whatsapp_bridge_relay_default_relays | to_json }}
  170. # The formats to use when sending messages via the relaybot.
  171. # Available variables:
  172. # .Sender.UserID - The Matrix user ID of the sender.
  173. # .Sender.Displayname - The display name of the sender (if set).
  174. # .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
  175. # .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
  176. # plus the user ID in parentheses if the displayname is not unique.
  177. # If the displayname is not set, this is just the user ID.
  178. # .Message - The `formatted_body` field of the message.
  179. # .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
  180. # .FileName - The name of the file being sent.
  181. message_formats:
  182. m.text: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}{% endraw %}"
  183. m.notice: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b>: {{ .Message }}{% endraw %}"
  184. m.emote: "{% raw %}* <b>{{ .Sender.DisambiguatedName }}</b> {{ .Message }}{% endraw %}"
  185. m.file: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
  186. m.image: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
  187. m.audio: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
  188. m.video: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
  189. m.location: "{% raw %}<b>{{ .Sender.DisambiguatedName }}</b> sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}{% endraw %}"
  190. # For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
  191. # This has all the Sender variables available under message_formats (but without the .Sender prefix).
  192. # Note that you need to manually remove the displayname from message_formats above.
  193. displayname_format: "{% raw %}{{ .DisambiguatedName }}{% endraw %}"
  194. # Permissions for using the bridge.
  195. # Permitted values:
  196. # relay - Talk through the relaybot (if enabled), no access otherwise
  197. # commands - Access to use commands in the bridge, but not login.
  198. # user - Access to use the bridge with puppeting.
  199. # admin - Full access, user level with some additional administration tools.
  200. # Permitted keys:
  201. # * - All Matrix users
  202. # domain - All users on that homeserver
  203. # mxid - Specific user
  204. permissions: {{ matrix_mautrix_whatsapp_bridge_permissions|to_json }}
  205. # Config for the bridge's database.
  206. database:
  207. # The database type. "sqlite3-fk-wal" and "postgres" are supported.
  208. type: {{ matrix_mautrix_whatsapp_appservice_database_type | to_json }}
  209. # The database URI.
  210. # SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
  211. # https://github.com/mattn/go-sqlite3#connection-string
  212. # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
  213. # To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
  214. uri: {{ matrix_mautrix_whatsapp_appservice_database_uri | to_json }}
  215. # Maximum number of connections.
  216. max_open_conns: 20
  217. max_idle_conns: 2
  218. # Maximum connection idle time and lifetime before they're closed. Disabled if null.
  219. # Parsed with https://pkg.go.dev/time#ParseDuration
  220. max_conn_idle_time: null
  221. max_conn_lifetime: null
  222. # Homeserver details.
  223. homeserver:
  224. # The address that this appservice can use to connect to the homeserver.
  225. # Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
  226. # but https also works if they run on different machines.
  227. address: {{ matrix_mautrix_whatsapp_homeserver_address | to_json }}
  228. # The domain of the homeserver (also known as server_name, used for MXIDs, etc).
  229. domain: {{ matrix_mautrix_whatsapp_homeserver_domain | to_json }}
  230. # What software is the homeserver running?
  231. # Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
  232. software: standard
  233. # The URL to push real-time bridge status to.
  234. # If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
  235. # The bridge will use the appservice as_token to authorize requests.
  236. status_endpoint:
  237. # Endpoint for reporting per-message status.
  238. # If set, the bridge will make POST requests to this URL when processing a message from Matrix.
  239. # It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
  240. # (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
  241. # The bridge will use the appservice as_token to authorize requests.
  242. message_send_checkpoint_endpoint:
  243. # Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
  244. async_media: false
  245. # Should the bridge use a websocket for connecting to the homeserver?
  246. # The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
  247. # mautrix-asmux (deprecated), and hungryserv (proprietary).
  248. websocket: false
  249. # How often should the websocket be pinged? Pinging will be disabled if this is zero.
  250. ping_interval_seconds: 0
  251. # Application service host/registration related details.
  252. # Changing these values requires regeneration of the registration (except when noted otherwise)
  253. appservice:
  254. # The address that the homeserver can use to connect to this appservice.
  255. # Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine.
  256. # If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard)
  257. # If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in.
  258. address: {{ matrix_mautrix_whatsapp_appservice_address | to_json }}
  259. # A public address that external services can use to reach this appservice.
  260. # This is only needed for things like public media. A reverse proxy is generally necessary when using this field.
  261. # This value doesn't affect the registration file.
  262. public_address: ""
  263. # The hostname and port where this appservice should listen.
  264. # For Docker, you generally have to change the hostname to 0.0.0.0.
  265. hostname: 0.0.0.0
  266. port: 8080
  267. # The unique ID of this appservice.
  268. id: whatsapp
  269. # Appservice bot details.
  270. bot:
  271. # Username of the appservice bot.
  272. username: {{ matrix_mautrix_whatsapp_appservice_bot_username | to_json }}
  273. # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
  274. # to leave display name/avatar as-is.
  275. displayname: WhatsApp bridge bot
  276. avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr
  277. # Whether to receive ephemeral events via appservice transactions.
  278. ephemeral_events: true
  279. # Should incoming events be handled asynchronously?
  280. # This may be necessary for large public instances with lots of messages going through.
  281. # However, messages will not be guaranteed to be bridged in the same order they were sent in.
  282. # This value doesn't affect the registration file.
  283. async_transactions: false
  284. # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
  285. as_token: {{ matrix_mautrix_whatsapp_appservice_token | to_json }}
  286. hs_token: {{ matrix_mautrix_whatsapp_homeserver_token | to_json }}
  287. # Localpart template of MXIDs for remote users.
  288. # {% raw %}{{.}}{% endraw %} is replaced with the internal ID of the user.
  289. username_template: "{% raw %}whatsapp_{{.}}{% endraw %}"
  290. # Config options that affect the Matrix connector of the bridge.
  291. matrix:
  292. # Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
  293. message_status_events: false
  294. # Whether the bridge should send a read receipt after successfully bridging a message.
  295. delivery_receipts: false
  296. # Whether the bridge should send error notices via m.notice events when a message fails to bridge.
  297. message_error_notices: true
  298. # Whether the bridge should update the m.direct account data event when double puppeting is enabled.
  299. sync_direct_chat_list: true
  300. # Whether created rooms should have federation enabled. If false, created portal rooms
  301. # will never be federated. Changing this option requires recreating rooms.
  302. federate_rooms: {{ matrix_mautrix_whatsapp_federate_rooms|to_json }}
  303. # The threshold as bytes after which the bridge should roundtrip uploads via the disk
  304. # rather than keeping the whole file in memory.
  305. upload_file_threshold: 5242880
  306. # Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
  307. analytics:
  308. # API key to send with tracking requests. Tracking is disabled if this is null.
  309. token: null
  310. # Address to send tracking requests to.
  311. url: https://api.segment.io/v1/track
  312. # Optional user ID for tracking events. If null, defaults to using Matrix user ID.
  313. user_id: null
  314. # Settings for provisioning API
  315. provisioning:
  316. # Prefix for the provisioning API paths.
  317. prefix: /_matrix/provision
  318. # Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
  319. # or if set to "disable", the provisioning API will be disabled.
  320. shared_secret: {{ matrix_mautrix_whatsapp_provisioning_shared_secret | to_json }}
  321. # Whether to allow provisioning API requests to be authed using Matrix access tokens.
  322. # This follows the same rules as double puppeting to determine which server to contact to check the token,
  323. # which means that by default, it only works for users on the same server as the bridge.
  324. allow_matrix_auth: true
  325. # Enable debug API at /debug with provisioning authentication.
  326. debug_endpoints: false
  327. # Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
  328. # These settings control whether the bridge will provide such public media access.
  329. public_media:
  330. # Should public media be enabled at all?
  331. # The public_address field under the appservice section MUST be set when enabling public media.
  332. enabled: false
  333. # A key for signing public media URLs.
  334. # If set to "generate", a random key will be generated.
  335. signing_key: {{ matrix_mautrix_whatsapp_public_media_signing_key | to_json }}
  336. # Number of seconds that public media URLs are valid for.
  337. # If set to 0, URLs will never expire.
  338. expiry: 0
  339. # Length of hash to use for public media URLs. Must be between 0 and 32.
  340. hash_length: 32
  341. # Settings for converting remote media to custom mxc:// URIs instead of reuploading.
  342. # More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
  343. direct_media:
  344. # Should custom mxc:// URIs be used instead of reuploading media?
  345. enabled: false
  346. # The server name to use for the custom mxc:// URIs.
  347. # This server name will effectively be a real Matrix server, it just won't implement anything other than media.
  348. # You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
  349. server_name: discord-media.example.com
  350. # Optionally a custom .well-known response. This defaults to `server_name:443`
  351. well_known_response:
  352. # Optionally specify a custom prefix for the media ID part of the MXC URI.
  353. media_id_prefix:
  354. # If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
  355. # media download redirects if the requester supports it. Optionally, you can force redirects
  356. # and not allow proxying at all by setting this to false.
  357. # This option does nothing if the remote network does not support media downloads over HTTP.
  358. allow_proxy: true
  359. # Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
  360. # This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
  361. server_key: ""
  362. # Settings for backfilling messages.
  363. # Note that the exact way settings are applied depends on the network connector.
  364. # See https://docs.mau.fi/bridges/general/backfill.html for more details.
  365. backfill:
  366. # Whether to do backfilling at all.
  367. enabled: {{ matrix_mautrix_whatsapp_backfill_enabled | to_json }}
  368. # Maximum number of messages to backfill in empty rooms.
  369. max_initial_messages: 50
  370. # Maximum number of missed messages to backfill after bridge restarts.
  371. max_catchup_messages: 500
  372. # If a backfilled chat is older than this number of hours,
  373. # mark it as read even if it's unread on the remote network.
  374. unread_hours_threshold: 720
  375. # Settings for backfilling threads within other backfills.
  376. threads:
  377. # Maximum number of messages to backfill in a new thread.
  378. max_initial_messages: 50
  379. # Settings for the backwards backfill queue. This only applies when connecting to
  380. # Beeper as standard Matrix servers don't support inserting messages into history.
  381. queue:
  382. # Should the backfill queue be enabled?
  383. enabled: false
  384. # Number of messages to backfill in one batch.
  385. batch_size: 100
  386. # Delay between batches in seconds.
  387. batch_delay: 20
  388. # Maximum number of batches to backfill per portal.
  389. # If set to -1, all available messages will be backfilled.
  390. max_batches: -1
  391. # Optional network-specific overrides for max batches.
  392. # Interpretation of this field depends on the network connector.
  393. max_batches_override: {}
  394. # Settings for enabling double puppeting
  395. double_puppet:
  396. # Servers to always allow double puppeting from.
  397. # This is only for other servers and should NOT contain the server the bridge is on.
  398. servers: {}
  399. # Whether to allow client API URL discovery for other servers. When using this option,
  400. # users on other servers can use double puppeting even if their server URLs aren't
  401. # explicitly added to the servers map above.
  402. allow_discovery: false
  403. # Shared secrets for automatic double puppeting.
  404. # See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
  405. secrets: {{ matrix_mautrix_whatsapp_double_puppet_secrets | to_json }}
  406. # End-to-bridge encryption support options.
  407. #
  408. # See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
  409. encryption:
  410. # Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
  411. allow: {{ matrix_mautrix_whatsapp_bridge_encryption_allow | to_json }}
  412. # Whether to force-enable encryption in all bridged rooms.
  413. default: {{ matrix_mautrix_whatsapp_bridge_encryption_default | to_json }}
  414. # Whether to require all messages to be encrypted and drop any unencrypted messages.
  415. require: {{ matrix_mautrix_whatsapp_bridge_encryption_require | to_json }}
  416. # Whether to use MSC2409/MSC3202 instead of /sync long polling for receiving encryption-related data.
  417. # This option is not yet compatible with standard Matrix servers like Synapse and should not be used.
  418. appservice: false
  419. # Whether to use MSC4190 instead of appservice login to create the bridge bot device.
  420. # Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
  421. # Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
  422. # Changing this option requires updating the appservice registration file.
  423. msc4190: {{ matrix_mautrix_whatsapp_msc4190_enabled | to_json }}
  424. # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
  425. # You must use a client that supports requesting keys from other users to use this feature.
  426. allow_key_sharing: {{ matrix_mautrix_whatsapp_bridge_encryption_key_sharing_allow | to_json }}
  427. # Pickle key for encrypting encryption keys in the bridge database.
  428. # If set to generate, a random key will be generated.
  429. pickle_key: {{ matrix_mautrix_whatsapp_bridge_encryption_pickle_key | to_json }}
  430. # Options for deleting megolm sessions from the bridge.
  431. delete_keys:
  432. # Beeper-specific: delete outbound sessions when hungryserv confirms
  433. # that the user has uploaded the key to key backup.
  434. delete_outbound_on_ack: false
  435. # Don't store outbound sessions in the inbound table.
  436. dont_store_outbound: false
  437. # Ratchet megolm sessions forward after decrypting messages.
  438. ratchet_on_decrypt: false
  439. # Delete fully used keys (index >= max_messages) after decrypting messages.
  440. delete_fully_used_on_decrypt: false
  441. # Delete previous megolm sessions from same device when receiving a new one.
  442. delete_prev_on_new_session: false
  443. # Delete megolm sessions received from a device when the device is deleted.
  444. delete_on_device_delete: false
  445. # Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
  446. periodically_delete_expired: false
  447. # Delete inbound megolm sessions that don't have the received_at field used for
  448. # automatic ratcheting and expired session deletion. This is meant as a migration
  449. # to delete old keys prior to the bridge update.
  450. delete_outdated_inbound: false
  451. # What level of device verification should be required from users?
  452. #
  453. # Valid levels:
  454. # unverified - Send keys to all device in the room.
  455. # cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
  456. # cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
  457. # cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
  458. # Note that creating user signatures from the bridge bot is not currently possible.
  459. # verified - Require manual per-device verification
  460. # (currently only possible by modifying the `trust` column in the `crypto_device` database table).
  461. verification_levels:
  462. # Minimum level for which the bridge should send keys to when bridging messages from the remote network to Matrix.
  463. receive: unverified
  464. # Minimum level that the bridge should accept for incoming Matrix messages.
  465. send: unverified
  466. # Minimum level that the bridge should require for accepting key requests.
  467. share: cross-signed-tofu
  468. # Options for Megolm room key rotation. These options allow you to configure the m.room.encryption event content.
  469. # See https://spec.matrix.org/v1.10/client-server-api/#mroomencryption for more information about that event.
  470. rotation:
  471. # Enable custom Megolm room key rotation settings. Note that these
  472. # settings will only apply to rooms created after this option is set.
  473. enable_custom: false
  474. # The maximum number of milliseconds a session should be used
  475. # before changing it. The Matrix spec recommends 604800000 (a week)
  476. # as the default.
  477. milliseconds: 604800000
  478. # The maximum number of messages that should be sent with a given a
  479. # session before changing it. The Matrix spec recommends 100 as the
  480. # default.
  481. messages: 100
  482. # Disable rotating keys when a user's devices change?
  483. # You should not enable this option unless you understand all the implications.
  484. disable_device_change_key_rotation: false
  485. # Logging config. See https://github.com/tulir/zeroconfig for details.
  486. logging:
  487. min_level: {{ matrix_mautrix_whatsapp_logging_level | to_json }}
  488. writers:
  489. - type: stdout
  490. format: pretty-colored