2021-04-11 06:29:12 +00:00
|
|
|
|
#jinja2: lstrip_blocks: "True"
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# Homeserver details
|
|
|
|
|
homeserver:
|
|
|
|
|
# The address that this appservice can use to connect to the homeserver.
|
2021-04-11 06:29:12 +00:00
|
|
|
|
address: {{ matrix_mautrix_twitter_homeserver_address }}
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# The domain of the homeserver (for MXIDs, etc).
|
2021-04-11 06:29:12 +00:00
|
|
|
|
domain: {{ matrix_mautrix_twitter_homeserver_domain }}
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# Whether or not to verify the SSL certificate of the homeserver.
|
|
|
|
|
# Only applies if address starts with https://
|
|
|
|
|
verify_ssl: true
|
|
|
|
|
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.
|
2021-04-11 06:29:12 +00:00
|
|
|
|
address: {{ matrix_mautrix_twitter_appservice_address }}
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# When using https:// the TLS certificate and key files for the address.
|
|
|
|
|
tls_cert: false
|
|
|
|
|
tls_key: false
|
2021-04-11 06:11:45 +00:00
|
|
|
|
|
|
|
|
|
# The hostname and port where this appservice should listen.
|
|
|
|
|
hostname: 0.0.0.0
|
2021-04-11 06:21:06 +00:00
|
|
|
|
port: 29327
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# 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.
|
2021-04-11 06:29:12 +00:00
|
|
|
|
database: {{ matrix_mautrix_twitter_appservice_database|to_json }}
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Additional arguments for asyncpg.create_pool()
|
|
|
|
|
# https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool
|
|
|
|
|
database_opts:
|
|
|
|
|
min_size: 5
|
|
|
|
|
max_size: 10
|
|
|
|
|
|
|
|
|
|
# Provisioning API part of the web server for automated portal creation and fetching information.
|
|
|
|
|
# Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager).
|
|
|
|
|
provisioning:
|
|
|
|
|
# Whether or not the provisioning API should be enabled.
|
|
|
|
|
enabled: true
|
|
|
|
|
# The prefix to use in the provisioning API endpoints.
|
|
|
|
|
prefix: /_matrix/provision/v1
|
|
|
|
|
# The shared secret to authorize users of the API.
|
|
|
|
|
# Set to "generate" to generate and save a new token.
|
2021-04-11 06:11:45 +00:00
|
|
|
|
shared_secret: generate
|
|
|
|
|
|
|
|
|
|
# The unique ID of this appservice.
|
2021-04-11 06:18:31 +00:00
|
|
|
|
id: twitter
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# Username of the appservice bot.
|
2021-04-11 06:29:12 +00:00
|
|
|
|
bot_username: {{ matrix_mautrix_twitter_appservice_bot_username|to_json }}
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
|
|
|
|
|
# to leave display name/avatar as-is.
|
2021-04-11 06:18:31 +00:00
|
|
|
|
bot_displayname: Twitter bridge bot
|
2021-04-11 06:21:06 +00:00
|
|
|
|
bot_avatar: mxc://maunium.net/HVHcnusJkQcpVcsVGZRELLCn
|
|
|
|
|
|
|
|
|
|
# Community ID for bridged users (changes registration file) and rooms.
|
|
|
|
|
# Must be created manually.
|
|
|
|
|
#
|
|
|
|
|
# Example: "+twitter:example.com". Set to false to disable.
|
|
|
|
|
community_id: false
|
2021-04-11 06:11:45 +00:00
|
|
|
|
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Whether or not to receive ephemeral events via appservice transactions.
|
|
|
|
|
# Requires MSC2409 support (i.e. Synapse 1.22+).
|
|
|
|
|
# You should disable bridge -> sync_with_custom_puppets when this is enabled.
|
|
|
|
|
ephemeral_events: false
|
|
|
|
|
|
|
|
|
|
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
|
2021-04-11 06:29:12 +00:00
|
|
|
|
as_token: "{{ matrix_mautrix_twitter_appservice_token }}"
|
|
|
|
|
hs_token: "{{ matrix_mautrix_twitter_homeserver_token }}"
|
2021-04-11 06:11:45 +00:00
|
|
|
|
|
|
|
|
|
# Prometheus telemetry config. Requires prometheus-client to be installed.
|
|
|
|
|
metrics:
|
|
|
|
|
enabled: false
|
|
|
|
|
listen_port: 8000
|
|
|
|
|
|
|
|
|
|
# Bridge config
|
|
|
|
|
bridge:
|
2021-04-11 06:18:31 +00:00
|
|
|
|
# Localpart template of MXIDs for Twitter users.
|
|
|
|
|
# {userid} is replaced with the user ID of the Twitter user.
|
|
|
|
|
username_template: "twitter_{userid}"
|
|
|
|
|
# Displayname template for Twitter users.
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# {displayname} is replaced with the display name of the Twitter user.
|
|
|
|
|
# {username} is replaced with the username of the Twitter user.
|
|
|
|
|
displayname_template: "{displayname} (Twitter)"
|
2021-04-11 06:11:45 +00:00
|
|
|
|
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Maximum length of displayname
|
|
|
|
|
displayname_max_length: 100
|
2021-04-11 06:11:45 +00:00
|
|
|
|
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Number of conversations to sync (and create portals for) on login.
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# Set 0 to disable automatic syncing.
|
2021-04-11 06:21:06 +00:00
|
|
|
|
initial_conversation_sync: 10
|
|
|
|
|
# Whether or not to use /sync to get read receipts and typing notifications
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# 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
|
|
|
|
|
# Allow using double puppeting from any server with a valid client .well-known file.
|
|
|
|
|
double_puppet_allow_discovery: false
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Servers to allow double puppeting from, even if double_puppet_allow_discovery is false.
|
2021-04-11 06:29:12 +00:00
|
|
|
|
double_puppet_server_map: {}
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Shared secret for https://github.com/devture/matrix-synapse-shared-secret-auth
|
2021-04-11 06:11:45 +00:00
|
|
|
|
#
|
|
|
|
|
# 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.
|
2021-04-11 06:29:12 +00:00
|
|
|
|
login_shared_secret_map: {{ matrix_mautrix_twitter_bridge_login_shared_secret_map|to_json }}
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Whether or not created rooms should have federation enabled.
|
|
|
|
|
# If false, created portal rooms will never be federated.
|
|
|
|
|
federate_rooms: true
|
|
|
|
|
# Settings for backfilling messages from Twitter.
|
2021-04-11 06:11:45 +00:00
|
|
|
|
#
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Missed message backfilling is currently based on receiving them from the Twitter polling API,
|
|
|
|
|
# rather than manually asking for messages in each conversation. Due to this, there's no way to
|
|
|
|
|
# set a limit for missed message backfilling.
|
|
|
|
|
backfill:
|
|
|
|
|
# Whether or not the Twitter users of logged in Matrix users should be
|
|
|
|
|
# invited to private chats when backfilling history from Twitter. 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.
|
2021-12-22 03:37:09 +00:00
|
|
|
|
initial_limit: 0
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# If using double puppeting, should notifications be disabled
|
|
|
|
|
# while the initial backfill is in progress?
|
2021-12-21 06:27:45 +00:00
|
|
|
|
disable_notifications: true
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# End-to-bridge encryption support options. You must install the e2be optional dependency for
|
|
|
|
|
# this to work. See https://github.com/tulir/mautrix-telegram/wiki/End‐to‐bridge-encryption
|
2021-04-11 06:11:45 +00:00
|
|
|
|
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
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Whether or not to explicitly set the avatar and room name for private
|
|
|
|
|
# chat portal rooms. This will be implicitly enabled if encryption.default is true.
|
|
|
|
|
private_chat_portal_meta: false
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# Whether or not the bridge should send a read receipt from the bridge bot when a message has
|
2021-04-11 06:18:31 +00:00
|
|
|
|
# been sent to Twitter.
|
2021-04-11 06:11:45 +00:00
|
|
|
|
delivery_receipts: false
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Whether or not delivery errors should be reported as messages in the Matrix room.
|
|
|
|
|
delivery_error_reports: false
|
|
|
|
|
# Whether or not non-fatal polling errors should send notices to the notice room.
|
2021-04-11 06:11:45 +00:00
|
|
|
|
temporary_disconnect_notices: true
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# Number of seconds to sleep more than the previous error when a polling error occurs.
|
|
|
|
|
# Growth is capped at 15 minutes.
|
|
|
|
|
error_sleep: 5
|
|
|
|
|
# Maximum number of polling errors before giving up. Set to -1 to retry forever.
|
|
|
|
|
max_poll_errors: 12
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# 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
|
|
|
|
|
|
2021-04-11 06:21:06 +00:00
|
|
|
|
# The prefix for commands. Only required in non-management rooms.
|
|
|
|
|
command_prefix: "!tw"
|
|
|
|
|
|
2021-04-11 06:11:45 +00:00
|
|
|
|
# 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:
|
2021-04-11 06:29:12 +00:00
|
|
|
|
'{{ matrix_mautrix_twitter_homeserver_domain }}': user
|
2021-04-11 06:21:06 +00:00
|
|
|
|
|
2021-04-11 06:11:45 +00:00
|
|
|
|
|
|
|
|
|
# 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:
|
2021-04-11 06:18:31 +00:00
|
|
|
|
(): mautrix_twitter.util.ColorFormatter
|
2021-04-11 06:11:45 +00:00
|
|
|
|
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
|
|
|
|
|
aiohttp:
|
|
|
|
|
level: INFO
|
|
|
|
|
root:
|
|
|
|
|
level: DEBUG
|
2021-04-11 06:29:12 +00:00
|
|
|
|
handlers: [console]
|