Matrix Docker Ansible eploy
Du kan inte välja fler än 25 ämnen Ämnen måste starta med en bokstav eller siffra, kan innehålla bindestreck ('-') och vara max 35 tecken långa.
 
 

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