c04a8583bf
All checks were successful
cc-ci/testme cc-ci: success
signalbridge: v0.8.7 -> v0.2606.0 (calver scheme change, already Go-based) telegrambridge: v0.15.3 -> v0.2606.0 (Python->Go bridgev2 rewrite; config template rewritten) signaldb/telegramdb/discorddb: postgres 13-alpine -> 14-alpine (PG13 EOL; conservative one-major bump) .env.sample: TELEGRAM_BRIDGE_PERMISSIONS relaybot -> relay (Go bridgev2 permission rename)
626 lines
34 KiB
Cheetah
626 lines
34 KiB
Cheetah
# Network-specific config options
|
|
network:
|
|
# Get your own API keys at https://my.telegram.org/apps
|
|
api_id: {{ env "TELEGRAM_APP_ID" }}
|
|
api_hash: {{ secret "telegram_api_hash" }}
|
|
|
|
# Device info shown in the Telegram device list.
|
|
device_info:
|
|
device_model: mautrix-telegram
|
|
system_version:
|
|
app_version: auto
|
|
lang_code: en
|
|
system_lang_code: en
|
|
|
|
# Settings for converting animated stickers.
|
|
animated_sticker:
|
|
# Format to which animated stickers should be converted.
|
|
#
|
|
# disable - no conversion, send as-is (gzipped lottie)
|
|
# png - converts to non-animated png (fastest),
|
|
# gif - converts to animated gif
|
|
# webm - converts to webm video, requires ffmpeg executable with vp9 codec
|
|
# and webm container support
|
|
# webp - converts to animated webp, requires ffmpeg executable with webp
|
|
# codec/container support
|
|
target: gif
|
|
# Should video stickers be converted to the specified format as well?
|
|
convert_from_webm: false
|
|
# Arguments for converter. All converters take width and height.
|
|
args:
|
|
width: 256
|
|
height: 256
|
|
fps: 25 # only for webm, webp and gif (2, 5, 10, 20 or 25 recommended)
|
|
|
|
# Settings for syncing the member list for portals.
|
|
member_list:
|
|
# Maximum number of members to sync per portal when starting up. Other
|
|
# members will be synced when they send messages. The maximum is 10000,
|
|
# after which the Telegram server will not send any more members.
|
|
#
|
|
# -1 means no limit (which means it's limited to 10000 by the server)
|
|
max_initial_sync: 100
|
|
# Whether or not to sync the member list in broadcast channels. If
|
|
# disabled, members will still be synced when they send messages.
|
|
#
|
|
# If no channel admins have logged into the bridge, the bridge won't be
|
|
# able to sync the member list regardless of this setting.
|
|
sync_broadcast_channels: {{ env "TELEGRAM_SYNC_CHANNEL_MEMBERS" }}
|
|
# Whether or not to skip deleted members when syncing members.
|
|
skip_deleted: true
|
|
|
|
# Settings for pings to the Telegram server.
|
|
ping:
|
|
# The interval (in seconds) between pings.
|
|
interval_seconds: 30
|
|
# The timeout (in seconds) for a single ping.
|
|
timeout_seconds: 10
|
|
|
|
# Proxy settings
|
|
proxy:
|
|
# Allowed types: disabled, socks5, mtproxy
|
|
type: disabled
|
|
# Proxy IP address/domain name and port.
|
|
address: "127.0.0.1:1080"
|
|
# Proxy authentication (optional). Put MTProxy secret in password field.
|
|
username:
|
|
password:
|
|
|
|
sync:
|
|
# Number of most recently active dialogs to check when syncing chats.
|
|
# Set to -1 to remove limit.
|
|
update_limit: 100
|
|
# Number of most recently active dialogs to create portals for when syncing chats.
|
|
# Set to -1 to remove limit.
|
|
create_limit: 15
|
|
# Number of chats to sync immediately on login before the data export is accepted.
|
|
# The create_limit above still applies. This is ignored if takeout.dialog_sync is false.
|
|
login_sync_limit: 15
|
|
# Whether or not to sync and create portals for direct chats at startup.
|
|
direct_chats: true
|
|
|
|
takeout:
|
|
# Should the bridge use the data export mode for syncing the full chat list?
|
|
# If true, login_sync_limit of chats is synced immediately on login,
|
|
# then the rest are synced after the takeout is accepted.
|
|
dialog_sync: false
|
|
# Should the bridge use the data export mode for forward backfilling messages?
|
|
# This should be set to true if the forward backfill limits are set to high values,
|
|
# but is probably not necessary otherwise.
|
|
forward_backfill: false
|
|
# Should the bridge use the data export mode for backward backfilling messages?
|
|
# This only affects the backfill queue, which is only available on Beeper.
|
|
backward_backfill: false
|
|
|
|
# Maximum number of participants in chats to bridge. Only applies when the
|
|
# portal is being created. If there are more members when trying to create
|
|
# a room, the room creation will be cancelled.
|
|
#
|
|
# -1 means no limit (which means all chats can be bridged)
|
|
max_member_count: -1
|
|
# Should personal avatars (that are only visible to specific users) be allowed?
|
|
contact_avatars: false
|
|
# Should contact names be updated from any source even if a name is already set?
|
|
# Note that contact names will still be used if there's no other name available.
|
|
contact_names: false
|
|
# Should the bridge send all unicode reactions as custom emoji reactions to
|
|
# Telegram? By default, the bridge only uses custom emojis for unicode emojis
|
|
# that aren't allowed in reactions.
|
|
always_custom_emoji_reaction: false
|
|
# The avatar to use for the Telegram Saved Messages chat
|
|
saved_message_avatar: mxc://maunium.net/XhhfHoPejeneOngMyBbtyWDk
|
|
# Create a new room and tombstone the old one when upgrading rooms
|
|
always_tombstone_on_supergroup_migration: false
|
|
# Maximum number of pixels in an image before sending to Telegram as a
|
|
# document. Defaults to 4096x4096 = 16777216.
|
|
image_as_file_pixels: 16777216
|
|
# Should view-once messages be disabled entirely?
|
|
disable_view_once: false
|
|
# Should video URL previews be bridged as m.video messages to Matrix?
|
|
# By default, video URL previews will not be bridged.
|
|
video_url_preview_as_file: false
|
|
# Displayname template for Telegram users.
|
|
# {{ "{{ .FullName }}" }} - the full name of the Telegram user
|
|
# {{ "{{ .FirstName }}" }} - the first name of the Telegram user
|
|
# {{ "{{ .LastName }}" }} - the last name of the Telegram user
|
|
# {{ "{{ .Username }}" }} - the primary username of the Telegram user, if the user has one
|
|
# {{ "{{ .UserID }}" }} - the internal user ID of the Telegram user
|
|
# {{ "{{ .Deleted }}" }} - true if the user has been deleted, false otherwise
|
|
displayname_template: '{{ "{{ if .Deleted }}Deleted account {{ .UserID }}{{ else }}{{ .FullName }}{{ end }}" }}'
|
|
|
|
|
|
# Config options that affect the central bridge module.
|
|
bridge:
|
|
# The prefix for commands. Only required in non-management rooms.
|
|
command_prefix: '!tg'
|
|
# Should the bridge create a space for each login containing the rooms that account is in?
|
|
personal_filtering_spaces: true
|
|
# Whether the bridge should set names and avatars explicitly for DM portals.
|
|
# This is only necessary when using clients that don't support MSC4171.
|
|
private_chat_portal_meta: true
|
|
# Should events be handled asynchronously within portal rooms?
|
|
# If true, events may end up being out of order, but slow events won't block other ones.
|
|
# This is not yet safe to use.
|
|
async_events: false
|
|
# Should every user have their own portals rather than sharing them?
|
|
# By default, users who are in the same group on the remote network will be
|
|
# in the same Matrix room bridged to that group. If this is set to true,
|
|
# every user will get their own Matrix room instead.
|
|
# SETTING THIS IS IRREVERSIBLE AND POTENTIALLY DESTRUCTIVE IF PORTALS ALREADY EXIST.
|
|
split_portals: false
|
|
# Should the bridge resend `m.bridge` events to all portals on startup?
|
|
resend_bridge_info: false
|
|
# Should `m.bridge` events be sent without a state key?
|
|
# By default, the bridge uses a unique key that won't conflict with other bridges.
|
|
no_bridge_info_state_key: false
|
|
# Should bridge connection status be sent to the management room as `m.notice` events?
|
|
# These contain the same data that can be posted to an external HTTP server using homeserver -> status_endpoint.
|
|
# Allowed values: none, errors, all
|
|
bridge_status_notices: errors
|
|
# How long after an unknown error should the bridge attempt a full reconnect?
|
|
# Must be at least 1 minute. The bridge will add an extra ±20% jitter to this value.
|
|
unknown_error_auto_reconnect: null
|
|
# Maximum number of times to do the auto-reconnect above.
|
|
# The counter is per login, but is never reset except on logout and restart.
|
|
unknown_error_max_auto_reconnects: 10
|
|
|
|
# Should leaving Matrix rooms be bridged as leaving groups on the remote network?
|
|
bridge_matrix_leave: false
|
|
# Should `m.notice` messages be bridged?
|
|
bridge_notices: false
|
|
# Should room tags only be synced when creating the portal? Tags mean things like favorite/pin and archive/low priority.
|
|
# Tags currently can't be synced back to the remote network, so a continuous sync means tagging from Matrix will be undone.
|
|
tag_only_on_create: true
|
|
# List of tags to allow bridging. If empty, no tags will be bridged.
|
|
only_bridge_tags: [m.favourite, m.lowpriority]
|
|
# Should room mute status only be synced when creating the portal?
|
|
# Like tags, mutes can't currently be synced back to the remote network.
|
|
mute_only_on_create: true
|
|
# Should the bridge check the db to ensure that incoming events haven't been handled before
|
|
deduplicate_matrix_messages: false
|
|
# Should cross-room reply metadata be bridged?
|
|
# Most Matrix clients don't support this and servers may reject such messages too.
|
|
cross_room_replies: false
|
|
# If a state event fails to bridge, should the bridge revert any state changes made by that event?
|
|
revert_failed_state_changes: false
|
|
# In portals with no relay set, should Matrix users be kicked if they're
|
|
# not logged into an account that's in the remote chat?
|
|
kick_matrix_users: true
|
|
# Should the bridge listen to com.beeper.state_request events?
|
|
# This is not necessary for anything outside of Beeper.
|
|
enable_send_state_requests: false
|
|
# Should the com.beeper.bridge.identifiers list in global ghost profiles include phone numbers?
|
|
phone_numbers_in_profile: false
|
|
|
|
# What should be done to portal rooms when a user logs out or is logged out?
|
|
# Permitted values:
|
|
# nothing - Do nothing, let the user stay in the portals
|
|
# kick - Remove the user from the portal rooms, but don't delete them
|
|
# unbridge - Remove all ghosts in the room and disassociate it from the remote chat
|
|
# delete - Remove all ghosts and users from the room (i.e. delete it)
|
|
cleanup_on_logout:
|
|
# Should cleanup on logout be enabled at all?
|
|
enabled: false
|
|
# Settings for manual logouts (explicitly initiated by the Matrix user)
|
|
manual:
|
|
# Action for private portals which will never be shared with other Matrix users.
|
|
private: nothing
|
|
# Action for portals with a relay user configured.
|
|
relayed: nothing
|
|
# Action for portals which may be shared, but don't currently have any other Matrix users.
|
|
shared_no_users: nothing
|
|
# Action for portals which have other logged-in Matrix users.
|
|
shared_has_users: nothing
|
|
# Settings for credentials being invalidated (initiated by the remote network, possibly through user action).
|
|
# Keys have the same meanings as in the manual section.
|
|
bad_credentials:
|
|
private: nothing
|
|
relayed: nothing
|
|
shared_no_users: nothing
|
|
shared_has_users: nothing
|
|
|
|
# Settings for relay mode
|
|
relay:
|
|
# Whether relay mode should be allowed. If allowed, the set-relay command can be used to turn any
|
|
# authenticated user into a relaybot for that chat.
|
|
enabled: true
|
|
# Should only admins be allowed to set themselves as relay users?
|
|
# If true, non-admins can only set users listed in default_relays as relays in a room.
|
|
admin_only: true
|
|
# Should default relays be preferred when an explicit login ID isn't specified even if the user is logged in?
|
|
# This applies to the set-relay and bridge commands sent by any user, including admins.
|
|
prefer_default: true
|
|
# Should non-admins be allowed to use the bridge and sync-chat commands via default relays specified below?
|
|
allow_bridge: true
|
|
# List of user login IDs which anyone can set as a relay, as long as the relay user is in the room.
|
|
default_relays: []
|
|
# The formats to use when sending messages via the relaybot.
|
|
# Available variables:
|
|
# .Sender.UserID - The Matrix user ID of the sender.
|
|
# .Sender.Displayname - The display name of the sender (if set).
|
|
# .Sender.RequiresDisambiguation - Whether the sender's name may be confused with the name of another user in the room.
|
|
# .Sender.DisambiguatedName - The disambiguated name of the sender. This will be the displayname if set,
|
|
# plus the user ID in parentheses if the displayname is not unique.
|
|
# If the displayname is not set, this is just the user ID.
|
|
# .Message - The `formatted_body` field of the message.
|
|
# .Caption - The `formatted_body` field of the message, if it's a caption. Otherwise an empty string.
|
|
# .FileName - The name of the file being sent.
|
|
message_formats:
|
|
m.text: "{{`{{ .Sender.DisambiguatedName }}: {{ .Message }}`}}"
|
|
m.notice: "{{`{{ .Sender.DisambiguatedName }}: {{ .Message }}`}}"
|
|
m.emote: "{{`* {{ .Sender.DisambiguatedName }} {{ .Message }}`}}"
|
|
m.file: "{{`{{ .Sender.DisambiguatedName }} sent a file{{ if .Caption }}: {{ .Caption }}{{ end }}`}}"
|
|
m.image: "{{`{{ .Sender.DisambiguatedName }} sent an image{{ if .Caption }}: {{ .Caption }}{{ end }}`}}"
|
|
m.audio: "{{`{{ .Sender.DisambiguatedName }} sent an audio file{{ if .Caption }}: {{ .Caption }}{{ end }}`}}"
|
|
m.video: "{{`{{ .Sender.DisambiguatedName }} sent a video{{ if .Caption }}: {{ .Caption }}{{ end }}`}}"
|
|
m.location: "{{`{{ .Sender.DisambiguatedName }} sent a location{{ if .Caption }}: {{ .Caption }}{{ end }}`}}"
|
|
# For networks that support per-message displaynames (i.e. Slack and Discord), the template for those names.
|
|
# This has all the Sender variables available under message_formats (but without the .Sender prefix).
|
|
# Note that you need to manually remove the displayname from message_formats above.
|
|
displayname_format: "{{`{{ .DisambiguatedName }}`}}"
|
|
|
|
# Filter for automatically creating portals.
|
|
portal_create_filter:
|
|
# The mode for filtering, either `deny` or `allow`
|
|
mode: deny
|
|
# The list of portal IDs to deny or allow depending on the mode config.
|
|
# Items here can either be the plain portal ID as a string, or an object with `id` and `receiver` fields.
|
|
# The receiver field is necessary if you want to target a specific DM portal for example.
|
|
list: []
|
|
# A list of user login IDs from which to always deny creating portals.
|
|
# This is meant to be used with default relays, such that the relay bot
|
|
# being added to a group wouldn't automatically trigger portal creation.
|
|
always_deny_from_login: []
|
|
|
|
# Permissions for using the bridge.
|
|
# Permitted values:
|
|
# relay - Talk through the relaybot (if enabled), no access otherwise
|
|
# commands - Access to use commands in the bridge, but not login.
|
|
# user - Access to use the bridge with puppeting.
|
|
# admin - Full access, user level with some additional administration tools.
|
|
# Permitted keys:
|
|
# * - All Matrix users
|
|
# domain - All users on that homeserver
|
|
# mxid - Specific user
|
|
permissions: {{ env "TELEGRAM_BRIDGE_PERMISSIONS" }}
|
|
|
|
# Config for the bridge's database.
|
|
database:
|
|
# The database type. "sqlite3-fk-wal" and "postgres" are supported.
|
|
type: postgres
|
|
# The database URI.
|
|
# SQLite: A raw file path is supported, but `file:<path>?_txlock=immediate` is recommended.
|
|
# https://github.com/mattn/go-sqlite3#connection-string
|
|
# Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
|
|
# To connect via Unix socket, use something like postgres:///dbname?host=/var/run/postgresql
|
|
uri: postgres://telegrambridge:{{ secret "telegram_db_password" }}@telegramdb/telegrambridge?sslmode=disable
|
|
# Maximum number of connections.
|
|
max_open_conns: 5
|
|
max_idle_conns: 1
|
|
# Maximum connection idle time and lifetime before they're closed. Disabled if null.
|
|
# Parsed with https://pkg.go.dev/time#ParseDuration
|
|
max_conn_idle_time: null
|
|
max_conn_lifetime: null
|
|
|
|
# Homeserver details.
|
|
homeserver:
|
|
# The address that this appservice can use to connect to the homeserver.
|
|
# Local addresses without HTTPS are generally recommended when the bridge is running on the same machine,
|
|
# but https also works if they run on different machines.
|
|
address: {{ env "HOMESERVER_URL" }}
|
|
# The domain of the homeserver (also known as server_name, used for MXIDs, etc).
|
|
domain: {{ env "HOMESERVER_DOMAIN" }}
|
|
|
|
# What software is the homeserver running?
|
|
# Standard Matrix homeservers like Synapse, Dendrite and Conduit should just use "standard" here.
|
|
software: standard
|
|
# The URL to push real-time bridge status to.
|
|
# If set, the bridge will make POST requests to this URL whenever a user's remote network connection state changes.
|
|
# The bridge will use the appservice as_token to authorize requests.
|
|
status_endpoint:
|
|
# Endpoint for reporting per-message status.
|
|
# If set, the bridge will make POST requests to this URL when processing a message from Matrix.
|
|
# It will make one request when receiving the message (step BRIDGE), one after decrypting if applicable
|
|
# (step DECRYPTED) and one after sending to the remote network (step REMOTE). Errors will also be reported.
|
|
# The bridge will use the appservice as_token to authorize requests.
|
|
message_send_checkpoint_endpoint:
|
|
# Does the homeserver support https://github.com/matrix-org/matrix-spec-proposals/pull/2246?
|
|
async_media: false
|
|
|
|
# Should the bridge use a websocket for connecting to the homeserver?
|
|
# The server side is currently not documented anywhere and is only implemented by mautrix-wsproxy,
|
|
# mautrix-asmux (deprecated), and hungryserv (proprietary).
|
|
websocket: false
|
|
# How often should the websocket be pinged? Pinging will be disabled if this is zero.
|
|
ping_interval_seconds: 0
|
|
# When requests to the homeserver fail with a 502/503/504/429 status or a network error,
|
|
# how many times should the bridge retry the request before giving up?
|
|
retry_limit: 4
|
|
|
|
# Application service host/registration related details.
|
|
# Changing these values requires regeneration of the registration (except when noted otherwise)
|
|
appservice:
|
|
# The address that the homeserver can use to connect to this appservice.
|
|
# Like the homeserver address, a local non-https address is recommended when the bridge is on the same machine.
|
|
# If the bridge is elsewhere, you must secure the connection yourself (e.g. with https or wireguard)
|
|
# If you want to use https, you need to use a reverse proxy. The bridge does not have TLS support built in.
|
|
address: http://telegrambridge:29317
|
|
# A public address that external services can use to reach this appservice.
|
|
# This is only needed for things like public media. A reverse proxy is generally necessary when using this field.
|
|
# This value doesn't affect the registration file.
|
|
public_address: https://bridge.example.com
|
|
|
|
# The hostname and port where this appservice should listen.
|
|
# For Docker, you generally have to change the hostname to 0.0.0.0.
|
|
hostname: 0.0.0.0
|
|
port: 29317
|
|
|
|
# The unique ID of this appservice.
|
|
id: {{ env "APP_SERVICE_ID" }}
|
|
# Appservice bot details.
|
|
bot:
|
|
# Username of the appservice bot.
|
|
username: {{ env "APP_SERVICE_BOT_USERNAME" }}
|
|
# Display name and avatar for bot. Set to "remove" to remove display name/avatar, leave empty
|
|
# to leave display name/avatar as-is.
|
|
displayname: {{ env "APP_SERVICE_DISPLAY_NAME" }}
|
|
avatar: mxc://maunium.net/tJCRmUyJDsgRNgqhOgoiHWbX
|
|
|
|
# Whether to receive ephemeral events via appservice transactions.
|
|
ephemeral_events: true
|
|
# Should incoming events be handled asynchronously?
|
|
# This may be necessary for large public instances with lots of messages going through.
|
|
# However, messages will not be guaranteed to be bridged in the same order they were sent in.
|
|
# This value doesn't affect the registration file.
|
|
async_transactions: false
|
|
|
|
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
|
|
as_token: "{{ secret "telegram_as_token" }}"
|
|
hs_token: "{{ secret "telegram_hs_token" }}"
|
|
|
|
# Localpart template of MXIDs for remote users.
|
|
# {{ "{{.}}" }} is replaced with the internal ID of the user.
|
|
username_template: telegram_{{ "{{.}}" }}
|
|
|
|
# Config options that affect the Matrix connector of the bridge.
|
|
matrix:
|
|
# Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
|
|
message_status_events: false
|
|
# Whether the bridge should send a read receipt after successfully bridging a message.
|
|
delivery_receipts: false
|
|
# Whether the bridge should send error notices via m.notice events when a message fails to bridge.
|
|
message_error_notices: true
|
|
# Whether the bridge should update the m.direct account data event when double puppeting is enabled.
|
|
sync_direct_chat_list: true
|
|
# Whether created rooms should have federation enabled. If false, created portal rooms
|
|
# will never be federated. Changing this option requires recreating rooms.
|
|
federate_rooms: true
|
|
# The threshold as bytes after which the bridge should roundtrip uploads via the disk
|
|
# rather than keeping the whole file in memory.
|
|
upload_file_threshold: 5242880
|
|
# Should the bridge set additional custom profile info for ghosts?
|
|
# This can make a lot of requests, as there's no batch profile update endpoint.
|
|
ghost_extra_profile_info: false
|
|
|
|
# Segment-compatible analytics endpoint for tracking some events, like provisioning API login and encryption errors.
|
|
analytics:
|
|
# API key to send with tracking requests. Tracking is disabled if this is null.
|
|
token: null
|
|
# Address to send tracking requests to.
|
|
url: https://api.segment.io/v1/track
|
|
# Optional user ID for tracking events. If null, defaults to using Matrix user ID.
|
|
user_id: null
|
|
|
|
# Settings for provisioning API
|
|
provisioning:
|
|
# Shared secret for authentication. If set to "generate" or null, a random secret will be generated,
|
|
# or if set to "disable", the provisioning API will be disabled. Must be at least 16 characters.
|
|
shared_secret: generate
|
|
# Whether to allow provisioning API requests to be authed using Matrix access tokens.
|
|
# This follows the same rules as double puppeting to determine which server to contact to check the token,
|
|
# which means that by default, it only works for users on the same server as the bridge.
|
|
allow_matrix_auth: true
|
|
# Enable debug API at /debug with provisioning authentication.
|
|
debug_endpoints: false
|
|
# Enable session transfers between bridges. Note that this only validates Matrix or shared secret
|
|
# auth before passing live network client credentials down in the response.
|
|
enable_session_transfers: false
|
|
|
|
# Some networks require publicly accessible media download links (e.g. for user avatars when using Discord webhooks).
|
|
# These settings control whether the bridge will provide such public media access.
|
|
public_media:
|
|
# Should public media be enabled at all?
|
|
# The public_address field under the appservice section MUST be set when enabling public media.
|
|
enabled: false
|
|
# A key for signing public media URLs.
|
|
# If set to "generate", a random key will be generated.
|
|
signing_key: generate
|
|
# Number of seconds that public media URLs are valid for.
|
|
# If set to 0, URLs will never expire.
|
|
expiry: 0
|
|
# Length of hash to use for public media URLs. Must be between 0 and 32.
|
|
hash_length: 32
|
|
# The path prefix for generated URLs. Note that this will NOT change the path where media is actually served.
|
|
# If you change this, you must configure your reverse proxy to rewrite the path accordingly.
|
|
path_prefix: /_mautrix/publicmedia
|
|
# Should the bridge store media metadata in the database in order to support encrypted media and generate shorter URLs?
|
|
# If false, the generated URLs will just have the MXC URI and a HMAC signature.
|
|
# The hash_length field will be used to decide the length of the generated URL.
|
|
# This also allows invalidating URLs by deleting the database entry.
|
|
use_database: false
|
|
|
|
# Settings for converting remote media to custom mxc:// URIs instead of reuploading.
|
|
# More details can be found at https://docs.mau.fi/bridges/go/discord/direct-media.html
|
|
direct_media:
|
|
# Should custom mxc:// URIs be used instead of reuploading media?
|
|
enabled: false
|
|
# The server name to use for the custom mxc:// URIs.
|
|
# This server name will effectively be a real Matrix server, it just won't implement anything other than media.
|
|
# You must either set up .well-known delegation from this domain to the bridge, or proxy the domain directly to the bridge.
|
|
server_name: discord-media.example.com
|
|
# Optionally a custom .well-known response. This defaults to `server_name:443`
|
|
well_known_response:
|
|
# Optionally specify a custom prefix for the media ID part of the MXC URI.
|
|
media_id_prefix:
|
|
# If the remote network supports media downloads over HTTP, then the bridge will use MSC3860/MSC3916
|
|
# media download redirects if the requester supports it. Optionally, you can force redirects
|
|
# and not allow proxying at all by setting this to false.
|
|
# This option does nothing if the remote network does not support media downloads over HTTP.
|
|
allow_proxy: true
|
|
# Matrix server signing key to make the federation tester pass, same format as synapse's .signing.key file.
|
|
# This key is also used to sign the mxc:// URIs to ensure only the bridge can generate them.
|
|
server_key: generate
|
|
|
|
# Settings for backfilling messages.
|
|
# Note that the exact way settings are applied depends on the network connector.
|
|
# See https://docs.mau.fi/bridges/general/backfill.html for more details.
|
|
backfill:
|
|
# Whether to do backfilling at all.
|
|
enabled: false
|
|
# Maximum number of messages to backfill in empty rooms.
|
|
# If this is zero or negative, backfill will be disabled in new rooms.
|
|
max_initial_messages: 50
|
|
# Maximum number of missed messages to backfill after bridge restarts.
|
|
max_catchup_messages: 500
|
|
# If a backfilled chat is older than this number of hours,
|
|
# mark it as read even if it's unread on the remote network.
|
|
unread_hours_threshold: 720
|
|
# Settings for backfilling threads within other backfills.
|
|
threads:
|
|
# Maximum number of messages to backfill in a new thread.
|
|
max_initial_messages: 50
|
|
# Settings for the backwards backfill queue. This only applies when connecting to
|
|
# Beeper as standard Matrix servers don't support inserting messages into history.
|
|
queue:
|
|
# Should the backfill queue be enabled?
|
|
enabled: false
|
|
# Should manual calls to backfill queue tasks be allowed?
|
|
manual: false
|
|
# Number of messages to backfill in one batch.
|
|
batch_size: 100
|
|
# Delay between batches in seconds.
|
|
batch_delay: 20
|
|
# Maximum number of batches to backfill per portal.
|
|
# If set to -1, all available messages will be backfilled.
|
|
max_batches: -1
|
|
# Optional network-specific overrides for max batches.
|
|
# Interpretation of this field depends on the network connector.
|
|
max_batches_override: {}
|
|
|
|
# Settings for enabling double puppeting
|
|
double_puppet:
|
|
# Servers to always allow double puppeting from.
|
|
# This is only for other servers and should NOT contain the server the bridge is on.
|
|
servers:
|
|
{{ env "HOMESERVER_DOMAIN" }}: {{ env "HOMESERVER_URL" }}
|
|
# Whether to allow client API URL discovery for other servers. When using this option,
|
|
# users on other servers can use double puppeting even if their server URLs aren't
|
|
# explicitly added to the servers map above.
|
|
allow_discovery: false
|
|
# Shared secrets for automatic double puppeting.
|
|
# See https://docs.mau.fi/bridges/general/double-puppeting.html for instructions.
|
|
secrets:
|
|
{{ env "HOMESERVER_DOMAIN" }}: {{ secret "shared_secret_auth" }}
|
|
|
|
# End-to-bridge encryption support options.
|
|
#
|
|
# See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
|
|
encryption:
|
|
# Whether to enable encryption at all. If false, the bridge will not function in encrypted rooms.
|
|
allow: {{ env "ENABLE_ENCRYPTION" }}
|
|
# Whether to force-enable encryption in all bridged rooms.
|
|
default: false
|
|
# Whether to require all messages to be encrypted and drop any unencrypted messages.
|
|
require: false
|
|
# Whether to use MSC3202/MSC4203 instead of /sync long polling for receiving encryption-related data.
|
|
# This is an experimental option, see the docs for more info.
|
|
# Changing this option requires updating the appservice registration file.
|
|
appservice: false
|
|
# Whether to use MSC4190 instead of appservice login to create the bridge bot device.
|
|
# Requires the homeserver to support MSC4190 and the device masquerading parts of MSC3202.
|
|
# Only relevant when using end-to-bridge encryption, required when using encryption with next-gen auth (MSC3861).
|
|
msc4190: false
|
|
# Whether to encrypt reactions and reply metadata as per MSC4392.
|
|
# This is not supported by most clients.
|
|
msc4392: false
|
|
# Should the bridge bot generate a recovery key and cross-signing keys and verify itself?
|
|
# Note that without the latest version of MSC4190, this will fail if you reset the bridge database.
|
|
# The generated recovery key will be saved in the kv_store table under `recovery_key`.
|
|
self_sign: false
|
|
# 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_key_sharing: true
|
|
# Should m.mentions be sent in the unencrypted content? This is non-standard and should not be enabled.
|
|
plaintext_mentions: false
|
|
# Pickle key for encrypting encryption keys in the bridge database.
|
|
# If set to generate, a random key will be generated.
|
|
pickle_key: generate
|
|
# Options for deleting megolm sessions from the bridge.
|
|
delete_keys:
|
|
# Beeper-specific: delete outbound sessions when hungryserv confirms
|
|
# that the user has uploaded the key to key backup.
|
|
delete_outbound_on_ack: false
|
|
# Don't store outbound sessions in the inbound table.
|
|
dont_store_outbound: false
|
|
# Ratchet megolm sessions forward after decrypting messages.
|
|
ratchet_on_decrypt: false
|
|
# Delete fully used keys (index >= max_messages) after decrypting messages.
|
|
delete_fully_used_on_decrypt: false
|
|
# Delete previous megolm sessions from same device when receiving a new one.
|
|
delete_prev_on_new_session: false
|
|
# Delete megolm sessions received from a device when the device is deleted.
|
|
delete_on_device_delete: false
|
|
# Periodically delete megolm sessions when 2x max_age has passed since receiving the session.
|
|
periodically_delete_expired: false
|
|
# Delete inbound megolm sessions that don't have the received_at field used for
|
|
# automatic ratcheting and expired session deletion. This is meant as a migration
|
|
# to delete old keys prior to the bridge update.
|
|
delete_outdated_inbound: false
|
|
# What level of device verification should be required from users?
|
|
#
|
|
# Valid levels:
|
|
# unverified - Send keys to all device in the room.
|
|
# cross-signed-untrusted - Require valid cross-signing, but trust all cross-signing keys.
|
|
# cross-signed-tofu - Require valid cross-signing, trust cross-signing keys on first use (and reject changes).
|
|
# cross-signed-verified - Require valid cross-signing, plus a valid user signature from the bridge bot.
|
|
# Note that creating user signatures from the bridge bot is not currently possible.
|
|
# verified - Require manual per-device verification
|
|
# (currently only possible by modifying the `trust` column in the `crypto_device` database table).
|
|
verification_levels:
|
|
# Minimum level for which the bridge should send keys to when bridging messages from the remote network to Matrix.
|
|
receive: unverified
|
|
# Minimum level that the bridge should accept for incoming Matrix messages.
|
|
send: unverified
|
|
# Minimum level that the bridge should require for accepting key requests.
|
|
share: cross-signed-tofu
|
|
# Options for Megolm room key rotation. These options allow you to configure the m.room.encryption event content.
|
|
# See https://spec.matrix.org/v1.10/client-server-api/#mroomencryption for more information about that event.
|
|
rotation:
|
|
# Enable custom Megolm room key rotation settings. Note that these
|
|
# settings will only apply to rooms created after this option is set.
|
|
enable_custom: false
|
|
# The maximum number of milliseconds a session should be used
|
|
# before changing it. The Matrix spec recommends 604800000 (a week)
|
|
# as the default.
|
|
milliseconds: 604800000
|
|
# The maximum number of messages that should be sent with a given a
|
|
# session before changing it. The Matrix spec recommends 100 as the
|
|
# default.
|
|
messages: 100
|
|
# Disable rotating keys when a user's devices change?
|
|
# You should not enable this option unless you understand all the implications.
|
|
disable_device_change_key_rotation: false
|
|
|
|
# Logging config. See https://github.com/tulir/zeroconfig for details.
|
|
logging:
|
|
min_level: debug
|
|
writers:
|
|
- type: stdout
|
|
format: pretty-colored
|
|
- type: file
|
|
format: json
|
|
filename: ./logs/bridge.log
|
|
max_size: 100
|
|
max_backups: 10
|
|
compress: false
|