|
- #jinja2: lstrip_blocks: "True"
- # Homeserver details
- homeserver:
- # The address that this appservice can use to connect to the homeserver.
- address: {{ matrix_mautrix_facebook_homeserver_address }}
- # The domain of the homeserver (for MXIDs, etc).
- domain: {{ matrix_mautrix_facebook_homeserver_domain }}
- # Whether or not to verify the SSL certificate of the homeserver.
- # Only applies if address starts with https://
- verify_ssl: true
- # Whether or not the homeserver supports asmux-specific endpoints,
- # such as /_matrix/client/unstable/net.maunium.asmux/dms for atomically
- # updating m.direct.
- asmux: false
-
- # Application service host/registration related details
- # Changing these values requires regeneration of the registration.
- appservice:
- # The address that the homeserver can use to connect to this appservice.
- address: {{ matrix_mautrix_facebook_appservice_address }}
-
- # The hostname and port where this appservice should listen.
- hostname: 0.0.0.0
- port: 29319
- # The maximum body size of appservice API requests (from the homeserver) in mebibytes
- # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s
- max_body_size: 1
-
- # The full URI to the database. Only Postgres is currently supported.
- database: {{ matrix_mautrix_facebook_appservice_database|to_json }}
-
- # Public part of web server for out-of-Matrix interaction with the bridge.
- public:
- # Whether or not the public-facing endpoints should be enabled.
- enabled: false
- # The prefix to use in the public-facing endpoints.
- prefix: /public
- # The base URL where the public-facing endpoints are available. The prefix is not added
- # implicitly.
- external: https://example.com/public
- # Shared secret for integration managers such as mautrix-manager.
- # If set to "generate", a random string will be generated on the next startup.
- # If null, integration manager access to the API will not be possible.
- shared_secret: generate
-
- # The unique ID of this appservice.
- id: facebook
- # Username of the appservice bot.
- bot_username: {{ matrix_mautrix_facebook_appservice_bot_username|to_json }}
- # Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
- # to leave display name/avatar as-is.
- bot_displayname: Facebook bridge bot
- bot_avatar: mxc://maunium.net/ygtkteZsXnGJLJHRchUwYWak
-
- # Authentication tokens for AS <-> HS communication.
- as_token: "{{ matrix_mautrix_facebook_appservice_token }}"
- hs_token: "{{ matrix_mautrix_facebook_homeserver_token }}"
-
- # Prometheus telemetry config. Requires prometheus-client to be installed.
- metrics:
- enabled: false
- listen_port: 8000
-
- # Bridge config
- bridge:
- # Localpart template of MXIDs for Facebook users.
- # {userid} is replaced with the user ID of the Facebook user.
- username_template: "facebook_{userid}"
- # Localpart template for per-user room grouping community IDs.
- # The bridge will create these communities and add all of the specific user's portals to the community.
- # {localpart} is the MXID localpart and {server} is the MXID server part of the user.
- #
- # `facebook_{localpart}={server}` is a good value.
- community_template: null
- # Displayname template for Facebook users.
- # {displayname} is replaced with the display name of the Facebook user
- # as defined below in displayname_preference.
- # Keys available for displayname_preference are also available here.
- displayname_template: '{displayname} (FB)'
- # Available keys:
- # "name" (full name)
- # "first_name"
- # "last_name"
- # "nickname"
- # "own_nickname" (user-specific!)
- displayname_preference:
- - name
- - first_name
-
- # The prefix for commands. Only required in non-management rooms.
- command_prefix: "!fb"
-
- # Number of chats to sync (and create portals for) on startup/login.
- # Set 0 to disable automatic syncing.
- initial_chat_sync: 10
- # Whether or not the Facebook users of logged in Matrix users should be
- # invited to private chats when the user sends a message from another client.
- invite_own_puppet_to_pm: false
- # Whether or not to use /sync to get presence, read receipts and typing notifications
- # when double puppeting is enabled
- sync_with_custom_puppets: true
- # Whether or not to update the m.direct account data event when double puppeting is enabled.
- # Note that updating the m.direct event is not atomic (except with mautrix-asmux)
- # and is therefore prone to race conditions.
- sync_direct_chat_list: false
- # Servers to always allow double puppeting from
- double_puppet_server_map: {}
- # example.com: https://example.com
- # Allow using double puppeting from any server with a valid client .well-known file.
- double_puppet_allow_discovery: false
- # Shared secrets for https://github.com/devture/matrix-synapse-shared-secret-auth
- #
- # If set, custom puppets will be enabled automatically for local users
- # instead of users having to find an access token and run `login-matrix`
- # manually.
- # If using this for other servers than the bridge's server,
- # you must also set the URL in the double_puppet_server_map.
- login_shared_secret_map: {{ matrix_mautrix_facebook_bridge_login_shared_secret_map|to_json }}
- presence: {{ matrix_mautrix_facebook_bridge_presence|to_json }}
- # Whether or not to update avatars when syncing all contacts at startup.
- update_avatar_initial_sync: true
- # End-to-bridge encryption support options. These require matrix-nio to be installed with pip
- # and login_shared_secret to be configured in order to get a device for the bridge bot.
- #
- # Additionally, https://github.com/matrix-org/synapse/pull/5758 is required if using a normal
- # application service.
- encryption:
- # Allow encryption, work in group chat rooms with e2ee enabled
- allow: false
- # Default to encryption, force-enable encryption in all portals the bridge creates
- # This will cause the bridge bot to be in private chats for the encryption to work properly.
- default: false
- # Options for automatic key sharing.
- key_sharing:
- # Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled.
- # You must use a client that supports requesting keys from other users to use this feature.
- allow: false
- # Require the requesting device to have a valid cross-signing signature?
- # This doesn't require that the bridge has verified the device, only that the user has verified it.
- # Not yet implemented.
- require_cross_signing: false
- # Require devices to be verified by the bridge?
- # Verification by the bridge is not yet implemented.
- require_verification: true
- # Whether or not the bridge should send a read receipt from the bridge bot when a message has
- # been sent to Facebook.
- delivery_receipts: false
- # Whether to allow inviting arbitrary mxids to portal rooms
- allow_invites: false
- # Settings for backfilling messages from Facebook.
- backfill:
- # Whether or not the Facebook users of logged in Matrix users should be
- # invited to private chats when backfilling history from Facebook. This is
- # usually needed to prevent rate limits and to allow timestamp massaging.
- invite_own_puppet: true
- # Maximum number of messages to backfill initially.
- # Set to 0 to disable backfilling when creating portal.
- initial_limit: 0
- # Maximum number of messages to backfill if messages were missed while
- # the bridge was disconnected.
- # Set to 0 to disable backfilling missed messages.
- missed_limit: 1000
- # If using double puppeting, should notifications be disabled
- # while the initial backfill is in progress?
- disable_notifications: false
- periodic_reconnect:
- # Interval in seconds in which to automatically reconnect all users.
- # This can be used to automatically mitigate the bug where Facebook stops sending messages.
- # Set to -1 to disable periodic reconnections entirely.
- interval: -1
- # What to do in periodic reconnects. Either "refresh" or "reconnect"
- mode: refresh
- # Should even disconnected users be reconnected?
- always: false
- # The number of seconds that a disconnection can last without triggering an automatic re-sync
- # and missed message backfilling when reconnecting.
- # Set to 0 to always re-sync, or -1 to never re-sync automatically.
- resync_max_disconnected_time: 5
- # Whether or not temporary disconnections should send notices to the notice room.
- # If this is false, disconnections will never send messages and connections will only send
- # messages if it was disconnected for more than resync_max_disconnected_time seconds.
- temporary_disconnect_notices: true
- # Whether or not the bridge should try to "refresh" the connection if a normal reconnection
- # attempt fails.
- refresh_on_reconnection_fail: false
- # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
- # This field will automatically be changed back to false after it,
- # except if the config file is not writable.
- resend_bridge_info: false
-
- # Permissions for using the bridge.
- # Permitted values:
- # user - Use the bridge with puppeting.
- # admin - Use and administrate the bridge.
- # Permitted keys:
- # * - All Matrix users
- # domain - All users on that homeserver
- # mxid - Specific user
- permissions:
- '{{ matrix_mautrix_facebook_homeserver_domain }}': user
-
- # Python logging configuration.
- #
- # See section 16.7.2 of the Python documentation for more info:
- # https://docs.python.org/3.6/library/logging.config.html#configuration-dictionary-schema
- logging:
- version: 1
- formatters:
- colored:
- (): mautrix_facebook.util.ColorFormatter
- format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
- normal:
- format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
- handlers:
- console:
- class: logging.StreamHandler
- formatter: colored
- loggers:
- mau:
- level: DEBUG
- paho:
- level: INFO
- aiohttp:
- level: INFO
- root:
- level: DEBUG
- handlers: [console]
|