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.
 
 
 

522 lines
30 KiB

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