example-config.yaml 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251
  1. # Homeserver details.
  2. homeserver:
  3. # The address that this appservice can use to connect to the homeserver.
  4. address: https://example.com
  5. # The domain of the homeserver (for MXIDs, etc).
  6. domain: example.com
  7. # Application service host/registration related details.
  8. # Changing these values requires regeneration of the registration.
  9. appservice:
  10. # The address that the homeserver can use to connect to this appservice.
  11. address: http://localhost:29318
  12. # The hostname and port where this appservice should listen.
  13. hostname: 0.0.0.0
  14. port: 29318
  15. # Database config.
  16. database:
  17. # The database type. "sqlite3" and "postgres" are supported.
  18. type: sqlite3
  19. # The database URI.
  20. # SQLite: File name is enough. https://github.com/mattn/go-sqlite3#connection-string
  21. # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
  22. uri: mautrix-whatsapp.db
  23. # Maximum number of connections. Mostly relevant for Postgres.
  24. max_open_conns: 20
  25. max_idle_conns: 2
  26. # Settings for provisioning API
  27. provisioning:
  28. # Prefix for the provisioning API paths.
  29. prefix: /_matrix/provision/v1
  30. # Shared secret for authentication. If set to "disable", the provisioning API will be disabled.
  31. shared_secret: disable
  32. # The unique ID of this appservice.
  33. id: whatsapp
  34. # Appservice bot details.
  35. bot:
  36. # Username of the appservice bot.
  37. username: whatsappbot
  38. # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
  39. # to leave display name/avatar as-is.
  40. displayname: WhatsApp bridge bot
  41. avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr
  42. # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
  43. as_token: "This value is generated when generating the registration"
  44. hs_token: "This value is generated when generating the registration"
  45. metrics:
  46. # Whether or not to enable prometheus metrics
  47. enabled: false
  48. # IP and port where the metrics listener should be. The path is always /metrics
  49. listen: 127.0.0.1:8001
  50. whatsapp:
  51. # Device name that's shown in the "WhatsApp Web" section in the mobile app
  52. device_name: Mautrix-WhatsApp bridge
  53. short_name: mx-wa
  54. # Bridge config
  55. bridge:
  56. # Localpart template of MXIDs for WhatsApp users.
  57. # {{.}} is replaced with the phone number of the WhatsApp user.
  58. username_template: whatsapp_{{.}}
  59. # Displayname template for WhatsApp users.
  60. # {{.Notify}} - nickname set by the WhatsApp user
  61. # {{.Jid}} - phone number (international format)
  62. # The following variables are also available, but will cause problems on multi-user instances:
  63. # {{.Name}} - display name from contact list
  64. # {{.Short}} - short display name from contact list
  65. # To use multiple if's, you need to use: {{else if .Name}}, for example:
  66. # "{{if .Notify}}{{.Notify}}{{else if .Name}}{{.Name}}{{else}}{{.Jid}}{{end}} (WA)"
  67. displayname_template: "{{if .Notify}}{{.Notify}}{{else}}{{.Jid}}{{end}} (WA)"
  68. # Localpart template for per-user room grouping community IDs.
  69. # On startup, the bridge will try to create these communities, add all of the specific user's
  70. # portals to the community, and invite the Matrix user to it.
  71. # (Note that, by default, non-admins might not have your homeserver's permission to create
  72. # communities.)
  73. # {{.Localpart}} is the MXID localpart and {{.Server}} is the MXID server part of the user.
  74. community_template: whatsapp_{{.Localpart}}={{.Server}}
  75. # WhatsApp connection timeout in seconds.
  76. connection_timeout: 20
  77. # If WhatsApp doesn't respond within connection_timeout, should the bridge try to fetch the message
  78. # to see if it was actually bridged? Use this if you have problems with sends timing out but actually
  79. # succeeding.
  80. fetch_message_on_timeout: false
  81. # Whether or not the bridge should send a read receipt from the bridge bot when a message has been
  82. # sent to WhatsApp. If fetch_message_on_timeout is enabled, a successful post-timeout fetch will
  83. # trigger a read receipt too.
  84. delivery_receipts: false
  85. # Number of times to regenerate QR code when logging in.
  86. # The regenerated QR code is sent as an edit and essentially multiplies the login timeout (20 seconds)
  87. login_qr_regen_count: 2
  88. # Maximum number of times to retry connecting on connection error.
  89. max_connection_attempts: 3
  90. # Number of seconds to wait between connection attempts.
  91. # Negative numbers are exponential backoff: -connection_retry_delay + 1 + 2^attempts
  92. connection_retry_delay: -1
  93. # Whether or not the bridge should send a notice to the user's management room when it retries connecting.
  94. # If false, it will only report when it stops retrying.
  95. report_connection_retry: true
  96. # Maximum number of seconds to wait for chats to be sent at startup.
  97. # If this is too low and you have lots of chats, it could cause backfilling to fail.
  98. chat_list_wait: 30
  99. # Maximum number of seconds to wait to sync portals before force unlocking message processing.
  100. # If this is too low and you have lots of chats, it could cause backfilling to fail.
  101. portal_sync_wait: 600
  102. user_message_buffer: 1024
  103. portal_message_buffer: 128
  104. # Whether or not to send call start/end notices to Matrix.
  105. call_notices:
  106. start: true
  107. end: true
  108. # Number of chats to sync for new users.
  109. initial_chat_sync_count: 10
  110. # Number of old messages to fill when creating new portal rooms.
  111. initial_history_fill_count: 20
  112. # Whether or not notifications should be turned off while filling initial history.
  113. # Only applicable when using double puppeting.
  114. initial_history_disable_notifications: false
  115. # Maximum number of chats to sync when recovering from downtime.
  116. # Set to -1 to sync all new chats during downtime.
  117. recovery_chat_sync_limit: -1
  118. # Whether or not to sync history when recovering from downtime.
  119. recovery_history_backfill: true
  120. # Maximum number of seconds since last message in chat to skip
  121. # syncing the chat in any case. This setting will take priority
  122. # over both recovery_chat_sync_limit and initial_chat_sync_count.
  123. # Default is 3 days = 259200 seconds
  124. sync_max_chat_age: 259200
  125. # Whether or not to sync with custom puppets to receive EDUs that
  126. # are not normally sent to appservices.
  127. sync_with_custom_puppets: true
  128. # When double puppeting is enabled, users can use `!wa toggle` to change whether or not
  129. # presence and read receipts are bridged. These settings set the default values.
  130. # Existing users won't be affected when these are changed.
  131. default_bridge_receipts: true
  132. default_bridge_presence: true
  133. # Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth
  134. #
  135. # If set, custom puppets will be enabled automatically for local users
  136. # instead of users having to find an access token and run `login-matrix`
  137. # manually.
  138. login_shared_secret: null
  139. # Whether or not to invite own WhatsApp user's Matrix puppet into private
  140. # chat portals when backfilling if needed.
  141. # This always uses the default puppet instead of custom puppets due to
  142. # rate limits and timestamp massaging.
  143. invite_own_puppet_for_backfilling: true
  144. # Whether or not to explicitly set the avatar and room name for private
  145. # chat portal rooms. This can be useful if the previous field works fine,
  146. # but causes room avatar/name bugs.
  147. private_chat_portal_meta: false
  148. # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
  149. # This field will automatically be changed back to false after it,
  150. # except if the config file is not writable.
  151. resend_bridge_info: false
  152. # Whether or not thumbnails from WhatsApp should be sent.
  153. # They're disabled by default due to very low resolution.
  154. whatsapp_thumbnail: false
  155. # Allow invite permission for user. User can invite any bots to room with whatsapp
  156. # users (private chat and groups)
  157. allow_user_invite: false
  158. # The prefix for commands. Only required in non-management rooms.
  159. command_prefix: "!wa"
  160. # End-to-bridge encryption support options. This requires login_shared_secret to be configured
  161. # in order to get a device for the bridge bot.
  162. #
  163. # Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal
  164. # application service.
  165. encryption:
  166. # Allow encryption, work in group chat rooms with e2ee enabled
  167. allow: false
  168. # Default to encryption, force-enable encryption in all portals the bridge creates
  169. # This will cause the bridge bot to be in private chats for the encryption to work properly.
  170. # It is recommended to also set private_chat_portal_meta to true when using this.
  171. default: false
  172. # Options for automatic key sharing.
  173. key_sharing:
  174. # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
  175. # You must use a client that supports requesting keys from other users to use this feature.
  176. allow: false
  177. # Require the requesting device to have a valid cross-signing signature?
  178. # This doesn't require that the bridge has verified the device, only that the user has verified it.
  179. # Not yet implemented.
  180. require_cross_signing: false
  181. # Require devices to be verified by the bridge?
  182. # Verification by the bridge is not yet implemented.
  183. require_verification: true
  184. # Permissions for using the bridge.
  185. # Permitted values:
  186. # relaybot - Talk through the relaybot (if enabled), no access otherwise
  187. # user - Access to use the bridge to chat with a WhatsApp account.
  188. # admin - User level and some additional administration tools
  189. # Permitted keys:
  190. # * - All Matrix users
  191. # domain - All users on that homeserver
  192. # mxid - Specific user
  193. permissions:
  194. "*": relaybot
  195. "example.com": user
  196. "@admin:example.com": admin
  197. relaybot:
  198. # Whether or not relaybot support is enabled.
  199. enabled: false
  200. # The management room for the bot. This is where all status notifications are posted and
  201. # in this room, you can use `!wa <command>` instead of `!wa relaybot <command>`. Omitting
  202. # the command prefix completely like in user management rooms is not possible.
  203. management: !foo:example.com
  204. # List of users to invite to all created rooms that include the relaybot.
  205. invites: []
  206. # The formats to use when sending messages to WhatsApp via the relaybot.
  207. message_formats:
  208. m.text: "<b>{{ .Sender.Displayname }}</b>: {{ .Message }}"
  209. m.notice: "<b>{{ .Sender.Displayname }}</b>: {{ .Message }}"
  210. m.emote: "* <b>{{ .Sender.Displayname }}</b> {{ .Message }}"
  211. m.file: "<b>{{ .Sender.Displayname }}</b> sent a file"
  212. m.image: "<b>{{ .Sender.Displayname }}</b> sent an image"
  213. m.audio: "<b>{{ .Sender.Displayname }}</b> sent an audio file"
  214. m.video: "<b>{{ .Sender.Displayname }}</b> sent a video"
  215. m.location: "<b>{{ .Sender.Displayname }}</b> sent a location"
  216. # Logging config.
  217. logging:
  218. # The directory for log files. Will be created if not found.
  219. directory: ./logs
  220. # Available variables: .Date for the file date and .Index for different log files on the same day.
  221. file_name_format: "{{.Date}}-{{.Index}}.log"
  222. # Date format for file names in the Go time format: https://golang.org/pkg/time/#pkg-constants
  223. file_date_format: 2006-01-02
  224. # Log file permissions.
  225. file_mode: 0600
  226. # Timestamp format for log entries in the Go time format.
  227. timestamp_format: Jan _2, 2006 15:04:05
  228. # Minimum severity for log messages.
  229. # Options: debug, info, warn, error, fatal
  230. print_level: debug