example-config.yaml 4.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. # Homeserver details.
  2. homeserver:
  3. # The address that this appservice can use to connect to the homeserver.
  4. address: https://matrix.org
  5. # The domain of the homeserver (for MXIDs, etc).
  6. domain: matrix.org
  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:8080
  12. # The hostname and port where this appservice should listen.
  13. hostname: 0.0.0.0
  14. port: 8080
  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
  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. # Path to the Matrix room state store.
  27. state_store_path: ./mx-state.json
  28. # The unique ID of this appservice.
  29. id: whatsapp
  30. # Appservice bot details.
  31. bot:
  32. # Username of the appservice bot.
  33. username: whatsappbot
  34. # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
  35. # to leave display name/avatar as-is.
  36. displayname: WhatsApp bridge bot
  37. avatar: mxc://maunium.net/NeXNQarUbrlYBiPCpprYsRqr
  38. # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
  39. as_token: "This value is generated when generating the registration"
  40. hs_token: "This value is generated when generating the registration"
  41. # Bridge config
  42. bridge:
  43. # Localpart template of MXIDs for WhatsApp users.
  44. # {{.}} is replaced with the phone number of the WhatsApp user.
  45. username_template: whatsapp_{{.}}
  46. # Displayname template for WhatsApp users.
  47. # {{.Notify}} - nickname set by the WhatsApp user
  48. # {{.Jid}} - phone number (international format)
  49. # The following variables are also available, but will cause problems on multi-user instances:
  50. # {{.Name}} - display name from contact list
  51. # {{.Short}} - short display name from contact list
  52. displayname_template: "{{if .Notify}}{{.Notify}}{{else}}{{.Jid}}{{end}} (WA)"
  53. # WhatsApp connection timeout in seconds.
  54. connection_timeout: 20
  55. # Maximum number of times to retry connecting on connection error.
  56. max_connection_attempts: 3
  57. # Whether or not the bridge should send a notice to the user's management room when it retries connecting.
  58. # If false, it will only report when it stops retrying.
  59. report_connection_retry: true
  60. # Number of chats to sync for new users.
  61. initial_chat_sync_count: 10
  62. # Number of old messages to fill when creating new portal rooms.
  63. initial_history_fill_count: 20
  64. # Maximum number of chats to sync when recovering from downtime.
  65. # Set to -1 to sync all new chats during downtime.
  66. recovery_chat_sync_limit: -1
  67. # Whether or not to sync history when recovering from downtime.
  68. recovery_history_backfill: true
  69. # Maximum number of seconds since last message in chat to skip
  70. # syncing the chat in any case. This setting will take priority
  71. # over both recovery_chat_sync_limit and initial_chat_sync_count.
  72. # Default is 3 days = 259200 seconds
  73. sync_max_chat_age: 259200
  74. # Whether or not to sync with custom puppets to receive EDUs that
  75. # are not normally sent to appservices.
  76. sync_with_custom_puppets: true
  77. # The prefix for commands. Only required in non-management rooms.
  78. command_prefix: "!wa"
  79. # Permissions for using the bridge.
  80. # Permitted values:
  81. # user - Access to use the bridge to chat with a WhatsApp account.
  82. # admin - User level and some additional administration tools
  83. # Permitted keys:
  84. # * - All Matrix users
  85. # domain - All users on that homeserver
  86. # mxid - Specific user
  87. permissions:
  88. "example.com": user
  89. "@admin:example.com": admin
  90. # Logging config.
  91. logging:
  92. # The directory for log files. Will be created if not found.
  93. directory: ./logs
  94. # Available variables: .Date for the file date and .Index for different log files on the same day.
  95. file_name_format: "{{.Date}}-{{.Index}}.log"
  96. # Date format for file names in the Go time format: https://golang.org/pkg/time/#pkg-constants
  97. file_date_format: 2006-01-02
  98. # Log file permissions.
  99. file_mode: 0600
  100. # Timestamp format for log entries in the Go time format.
  101. timestamp_format: Jan _2, 2006 15:04:05
  102. # Minimum severity for log messages.
  103. # Options: debug, info, warn, error, fatal
  104. print_level: debug