diff --git a/.env.sample b/.env.sample
index 8b9c329..e5dd785 100644
--- a/.env.sample
+++ b/.env.sample
@@ -211,13 +211,16 @@ RETENTION_MAX_LIFETIME=4w
#COMPOSE_FILE="$COMPOSE_FILE:compose.telegram.yml"
#APP_SERVICE_BOT_USERNAME=telegrambot
#APP_SERVICE_DISPLAY_NAME="Telegram bridge bot"
-#APP_SERVICE_ID=
+#APP_SERVICE_ID=telegrambot
#HOMESERVER_DOMAIN=$DOMAIN
#HOMESERVER_URL=https://$DOMAIN
#VERIFY_SSL=false
#ENABLE_ENCRYPTION=true
#TELEGRAM_APP_ID=
-#TELEGRAM_BRIDGE_PERMISSIONS="{ \"*\": \"relaybot\", \"@foo:matrix.example.com\": \"admin\" }"
+# NOTE (bridgev2): a wildcard-only permissions map is rejected by the bridge; include at least
+# one real domain or mxid entry. The legacy "relaybot" level no longer exists upstream -
+# use "relay" together with bridge relay mode instead.
+#TELEGRAM_BRIDGE_PERMISSIONS="{ \"*\": \"relay\", \"matrix.example.com\": \"user\" }"
#TELEGRAM_SYNC_CHANNEL_MEMBERS=true
#SECRET_TELEGRAM_DB_PASSWORD_VERSION=v1
#SECRET_TELEGRAM_API_HASH_VERSION=v1
@@ -238,8 +241,9 @@ RETENTION_MAX_LIFETIME=4w
#COMPOSE_FILE="$COMPOSE_FILE:compose.signal.yml"
#SIGNAL_ENABLE_ENCRYPTION=true
#SIGNAL_DEFAULT_ENCRYPTION=true
-#SIGNAL_BRIDGE_PERMISSIONS="{ \"*\": \"relay\" }"
-#SECRET_SIGNAL_AS_TOKEN_VERSION=v1
+# NOTE (bridgev2): a wildcard-only permissions map is rejected by the bridge; include at least
+# one real domain or mxid entry.
+#SIGNAL_BRIDGE_PERMISSIONS="{ \"*\": \"relay\", \"matrix.example.com\": \"user\" }"
#SECRET_SIGNAL_DB_PASSWORD_VERSION=v1
#SECRET_SIGNAL_HS_TOKEN_VERSION=v1
#SECRET_SIGNAL_PICKLE_KEY_VERSION=v1
diff --git a/abra.sh b/abra.sh
index 288cc43..a3eca65 100644
--- a/abra.sh
+++ b/abra.sh
@@ -1,10 +1,12 @@
export DISCORD_BRIDGE_YAML_VERSION=v2
-export ENTRYPOINT_CONF_VERSION=v3
+export ENTRYPOINT_CONF_VERSION=v4
export HOMESERVER_YAML_VERSION=v37
export LOG_CONFIG_VERSION=v2
export SHARED_SECRET_AUTH_VERSION=v2
-export SIGNAL_BRIDGE_YAML_VERSION=v6
-export TELEGRAM_BRIDGE_YAML_VERSION=v6
+export SIGNAL_BRIDGE_YAML_VERSION=v9
+export SIGNAL_RUN_SCRIPT_VERSION=v1
+export TELEGRAM_RUN_SCRIPT_VERSION=v1
+export TELEGRAM_BRIDGE_YAML_VERSION=v9
export NGINX_CONFIG_VERSION=v13
export WK_SERVER_VERSION=v1
export WK_CLIENT_VERSION=v2
diff --git a/compose.signal.yml b/compose.signal.yml
index ac91a2f..47e5da0 100644
--- a/compose.signal.yml
+++ b/compose.signal.yml
@@ -10,12 +10,16 @@ services:
- signal-data:/signal-data
signalbridge:
- image: dock.mau.dev/mautrix/signal:v0.2609.0
+ image: dock.mau.dev/mautrix/signal:v0.2611.0
depends_on:
- signaldb
+ entrypoint: /bridge-run.sh
configs:
- source: signal_bridge_yaml
target: /data/config.yaml
+ - source: signal_run_script
+ target: /bridge-run.sh
+ mode: 0555
environment:
- HOMESERVER_DOMAIN
- HOMESERVER_URL
@@ -66,6 +70,10 @@ configs:
name: ${STACK_NAME}_signal_bridge_yaml_${SIGNAL_BRIDGE_YAML_VERSION}
file: signal_bridge.yaml.tmpl
template_driver: golang
+ signal_run_script:
+ name: ${STACK_NAME}_signal_run_script_${SIGNAL_RUN_SCRIPT_VERSION}
+ file: signal-run.sh.tmpl
+ template_driver: golang
volumes:
signal-data:
diff --git a/compose.telegram.yml b/compose.telegram.yml
index 9d6fd62..76c5fa4 100644
--- a/compose.telegram.yml
+++ b/compose.telegram.yml
@@ -10,12 +10,16 @@ services:
- telegram-data:/telegram-data
telegrambridge:
- image: dock.mau.dev/mautrix/telegram:v0.2609.0
+ image: dock.mau.dev/mautrix/telegram:v0.2611.0
depends_on:
- telegramdb
+ entrypoint: /bridge-run.sh
configs:
- source: telegram_bridge_yaml
target: /data/config.yaml
+ - source: telegram_run_script
+ target: /bridge-run.sh
+ mode: 0555
environment:
- APP_SERVICE_BOT_USERNAME
- APP_SERVICE_DISPLAY_NAME
@@ -71,6 +75,10 @@ configs:
name: ${STACK_NAME}_telegram_bridge_yaml_${TELEGRAM_BRIDGE_YAML_VERSION}
file: telegram_bridge.yaml.tmpl
template_driver: golang
+ telegram_run_script:
+ name: ${STACK_NAME}_telegram_run_script_${TELEGRAM_RUN_SCRIPT_VERSION}
+ file: telegram-run.sh.tmpl
+ template_driver: golang
volumes:
telegram-data:
diff --git a/entrypoint.sh.tmpl b/entrypoint.sh.tmpl
index 60f45e9..25f72f8 100644
--- a/entrypoint.sh.tmpl
+++ b/entrypoint.sh.tmpl
@@ -13,4 +13,8 @@ if [[ -d /signal-data ]]; then
chown -R 991:991 /signal-data
fi
+if [[ -d /telegram-data ]]; then
+ chown -R 991:991 /telegram-data
+fi
+
/start.py
diff --git a/signal-run.sh.tmpl b/signal-run.sh.tmpl
new file mode 100644
index 0000000..4a6e883
--- /dev/null
+++ b/signal-run.sh.tmpl
@@ -0,0 +1,42 @@
+#!/bin/bash
+# Co-op Cloud launcher for mautrix-signal (replaces the image's docker-run.sh).
+#
+# The image's docker-run.sh generates the appservice registration with RANDOM
+# tokens and then writes those tokens back into /data/config.yaml. In this
+# recipe the config is a read-only docker config mount sourced from secrets,
+# so that write can never succeed and the generated tokens would never match
+# the config (synapse reads the registration, the bridge reads the config ->
+# permanent 401). The config is therefore the source of truth: after
+# generation the registration is rewritten to match it, so both sides agree.
+BINARY_NAME=/usr/bin/mautrix-signal
+
+if [[ ! -s /data/config.yaml ]]; then
+ $BINARY_NAME -c /data/config.yaml -e
+fi
+
+if [[ ! -f /data/registration.yaml ]]; then
+ # -g generates a registration with random tokens and tries to save them
+ # into the (read-only) config; both are corrected below.
+ $BINARY_NAME -g -c /data/config.yaml -r /data/registration.yaml || true
+fi
+
+if [[ -f /data/registration.yaml ]]; then
+ AS_TOKEN=$(cat /run/secrets/signal_as_token)
+ HS_TOKEN=$(cat /run/secrets/signal_hs_token)
+ if ! grep -q "^as_token: ${AS_TOKEN}$" /data/registration.yaml; then
+ sed -i "s/^as_token:.*/as_token: ${AS_TOKEN}/" /data/registration.yaml || true
+ fi
+ if ! grep -q "^hs_token: ${HS_TOKEN}$" /data/registration.yaml; then
+ sed -i "s/^hs_token:.*/hs_token: ${HS_TOKEN}/" /data/registration.yaml || true
+ fi
+ if ! grep -q "^sender_localpart: signalbot$" /data/registration.yaml; then
+ sed -i "s/^sender_localpart:.*/sender_localpart: signalbot/" /data/registration.yaml || true
+ fi
+ # synapse (uid 991) must be able to read the registration even though the
+ # bridge (uid 1337) owns it; the synapse entrypoint chowns the volume at
+ # its own start, but make the file readable regardless of ownership.
+ chmod 644 /data/registration.yaml 2>/dev/null || true
+fi
+
+cd /data
+exec su-exec $UID:$GID $BINARY_NAME -c /data/config.yaml
diff --git a/signal_bridge.yaml.tmpl b/signal_bridge.yaml.tmpl
index dd37692..4c3dd89 100644
--- a/signal_bridge.yaml.tmpl
+++ b/signal_bridge.yaml.tmpl
@@ -399,13 +399,10 @@ encryption:
# Logging config. See https://github.com/tulir/zeroconfig for details.
logging:
- min_level: debug
+ # File logging is deliberately disabled: docker collects stdout, and the
+ # synapse entrypoint chowns the shared data volume, so the bridge must not
+ # need to write into /data at runtime.
+ min_level: info
writers:
- type: stdout
format: pretty-colored
- - type: file
- format: json
- filename: ./logs/bridge.log
- max_size: 100
- max_backups: 10
- compress: false
diff --git a/telegram-run.sh.tmpl b/telegram-run.sh.tmpl
new file mode 100644
index 0000000..f1b794e
--- /dev/null
+++ b/telegram-run.sh.tmpl
@@ -0,0 +1,42 @@
+#!/bin/bash
+# Co-op Cloud launcher for mautrix-telegram (replaces the image's docker-run.sh).
+#
+# The image's docker-run.sh generates the appservice registration with RANDOM
+# tokens and then writes those tokens back into /data/config.yaml. In this
+# recipe the config is a read-only docker config mount sourced from secrets,
+# so that write can never succeed and the generated tokens would never match
+# the config (synapse reads the registration, the bridge reads the config ->
+# permanent 401). The config is therefore the source of truth: after
+# generation the registration is rewritten to match it, so both sides agree.
+BINARY_NAME=/usr/bin/mautrix-telegram
+
+if [[ ! -s /data/config.yaml ]]; then
+ $BINARY_NAME -c /data/config.yaml -e
+fi
+
+if [[ ! -f /data/registration.yaml ]]; then
+ # -g generates a registration with random tokens and tries to save them
+ # into the (read-only) config; both are corrected below.
+ $BINARY_NAME -g -c /data/config.yaml -r /data/registration.yaml || true
+fi
+
+if [[ -f /data/registration.yaml ]]; then
+ AS_TOKEN=$(cat /run/secrets/telegram_as_token)
+ HS_TOKEN=$(cat /run/secrets/telegram_hs_token)
+ if ! grep -q "^as_token: ${AS_TOKEN}$" /data/registration.yaml; then
+ sed -i "s/^as_token:.*/as_token: ${AS_TOKEN}/" /data/registration.yaml || true
+ fi
+ if ! grep -q "^hs_token: ${HS_TOKEN}$" /data/registration.yaml; then
+ sed -i "s/^hs_token:.*/hs_token: ${HS_TOKEN}/" /data/registration.yaml || true
+ fi
+ if ! grep -q "^sender_localpart: {{ env "APP_SERVICE_BOT_USERNAME" }}$" /data/registration.yaml; then
+ sed -i "s/^sender_localpart:.*/sender_localpart: {{ env "APP_SERVICE_BOT_USERNAME" }}/" /data/registration.yaml || true
+ fi
+ # synapse (uid 991) must be able to read the registration even though the
+ # bridge (uid 1337) owns it; the synapse entrypoint chowns the volume at
+ # its own start, but make the file readable regardless of ownership.
+ chmod 644 /data/registration.yaml 2>/dev/null || true
+fi
+
+cd /data
+exec su-exec $UID:$GID $BINARY_NAME -c /data/config.yaml
diff --git a/telegram_bridge.yaml.tmpl b/telegram_bridge.yaml.tmpl
index 11b10d0..1ab5f4c 100644
--- a/telegram_bridge.yaml.tmpl
+++ b/telegram_bridge.yaml.tmpl
@@ -1,544 +1,228 @@
-# Homeserver details
-homeserver:
- # The address that this appservice can use to connect to the homeserver.
- address: {{ env "HOMESERVER_URL" }}
- # The domain of the homeserver (for MXIDs, etc).
- domain: {{ env "HOMESERVER_DOMAIN" }}
- # Whether or not to verify the SSL certificate of the homeserver.
- # Only applies if address starts with https://
- verify_ssl: {{ env "VERIFY_SSL" }}
- asmux: false
- # Number of retries for all HTTP requests if the homeserver isn't reachable.
- http_retry_count: 4
- # The URL to push real-time bridge status to.
- # If set, the bridge will make POST requests to this URL whenever a user's Telegram connection state changes.
- # The bridge will use the appservice as_token to authorize requests.
- status_endpoint: null
- # Endpoint for reporting per-message status.
- message_send_checkpoint_endpoint: null
- # Whether asynchronous uploads via MSC2246 should be enabled for media.
- # Requires a media repo that supports MSC2246.
- async_media: 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: http://telegrambridge:29317
- # When using https:// the TLS certificate and key files for the address.
- tls_cert: false
- tls_key: false
-
- # The hostname and port where this appservice should listen.
- hostname: 0.0.0.0
- port: 29317
- # 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. SQLite and Postgres are supported.
- # Format examples:
- # SQLite: sqlite:///filename.db
- # Postgres: postgres://username:password@hostname/dbname
- database: postgres://telegrambridge:{{ secret "telegram_db_password" }}@telegramdb/telegrambridge
- # Additional arguments for asyncpg.create_pool() or sqlite3.connect()
- # https://magicstack.github.io/asyncpg/current/api/index.html#asyncpg.pool.create_pool
- # https://docs.python.org/3/library/sqlite3.html#sqlite3.connect
- # For sqlite, min_size is used as the connection thread pool size and max_size is ignored.
- database_opts:
- min_size: 1
- max_size: 10
-
- # Public part of web server for out-of-Matrix interaction with the bridge.
- # Used for things like login if the user wants to make sure the 2FA password isn't stored in
- # the HS database.
- 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
-
- # 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: false
- # The prefix to use in the provisioning API endpoints.
- prefix: /_matrix/provision
- # The shared secret to authorize users of the API.
- # Set to "generate" to generate and save a new token.
- shared_secret: generate
-
- # The unique ID of this appservice.
- id: {{ env "APP_SERVICE_ID" }}
- # Username of the appservice bot.
- 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.
- bot_displayname: {{ env "APP_SERVICE_DISPLAY_NAME" }}
- bot_avatar: mxc://maunium.net/tJCRmUyJDsgRNgqhOgoiHWbX
-
- # 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.
- as_token: "{{ secret "telegram_as_token" }}"
- hs_token: "{{ secret "telegram_hs_token" }}"
-
-# Prometheus telemetry config. Requires prometheus-client to be installed.
-metrics:
- enabled: false
- listen_port: 8000
-
-# Manhole config.
-manhole:
- # Whether or not opening the manhole is allowed.
- enabled: false
- # The path for the unix socket.
- path: /var/tmp/mautrix-telegram.manhole
- # The list of UIDs who can be added to the whitelist.
- # If empty, any UIDs can be specified in the open-manhole command.
- whitelist:
- - 0
-
-# Bridge config
-bridge:
- # Localpart template of MXIDs for Telegram users.
- # {userid} is replaced with the user ID of the Telegram user.
- username_template: "telegram_{userid}"
- # Localpart template of room aliases for Telegram portal rooms.
- # {groupname} is replaced with the name part of the public channel/group invite link ( https://t.me/{} )
- alias_template: "telegram_{groupname}"
- # Displayname template for Telegram users.
- # {displayname} is replaced with the display name of the Telegram user.
- displayname_template: "{displayname} (Telegram)"
-
- # Set the preferred order of user identifiers which to use in the Matrix puppet display name.
- # In the (hopefully unlikely) scenario that none of the given keys are found, the numeric user
- # ID is used.
- #
- # If the bridge is working properly, a phone number or an username should always be known, but
- # the other one can very well be empty.
- #
- # Valid keys:
- # "full name" (First and/or last name)
- # "full name reversed" (Last and/or first name)
- # "first name"
- # "last name"
- # "username"
- # "phone number"
- displayname_preference:
- - full name
- - username
- - phone number
- # Maximum length of displayname
- displayname_max_length: 100
- # Remove avatars from Telegram ghost users when removed on Telegram. This is disabled by default
- # as there's no way to determine whether an avatar is removed or just hidden from some users. If
- # you're on a single-user instance, this should be safe to enable.
- allow_avatar_remove: false
-
- # 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_member_sync: 100
- # Whether or not to sync the member list in channels.
- # 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_channel_members: {{ env "TELEGRAM_SYNC_CHANNEL_MEMBERS" }}
- # Whether or not to skip deleted members when syncing members.
- skip_deleted_members: true
- # Whether or not to automatically synchronize contacts and chats of Matrix users logged into
- # their Telegram account at startup.
- startup_sync: true
- # Number of most recently active dialogs to check when syncing chats.
- # Set to 0 to remove limit.
- sync_update_limit: 0
- # Number of most recently active dialogs to create portals for when syncing chats.
- # Set to 0 to remove limit.
- sync_create_limit: 30
- # Whether or not to sync and create portals for direct chats at startup.
- sync_direct_chats: false
- # The maximum number of simultaneous Telegram deletions to handle.
- # A large number of simultaneous redactions could put strain on your homeserver.
- max_telegram_delete: 10
- # Whether or not to automatically sync the Matrix room state (mostly unpuppeted displaynames)
- # at startup and when creating a bridge.
- sync_matrix_state: true
- # Allow logging in within Matrix. If false, users can only log in using login-qr or the
- # out-of-Matrix login website (see appservice.public config section)
- allow_matrix_login: true
- # Whether or not to bridge plaintext highlights.
- # Only enable this if your displayname_template has some static part that the bridge can use to
- # reliably identify what is a plaintext highlight.
- plaintext_highlights: false
- # Whether or not to make portals of publicly joinable channels/supergroups publicly joinable on Matrix.
- public_portals: true
- # 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:
- {{ env "HOMESERVER_DOMAIN" }}: {{ env "HOMESERVER_URL" }}
- # 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:
- {{ env "HOMESERVER_DOMAIN" }}: {{ secret "shared_secret_auth" }}
- # Set to false to disable link previews in messages sent to Telegram.
- telegram_link_preview: true
- # Whether or not the !tg join command should do a HTTP request
- # to resolve redirects in invite links.
- invite_link_resolve: false
- # Use inline images instead of a separate message for the caption.
- # N.B. Inline images are not supported on all clients (e.g. Element iOS/Android).
- inline_images: false
- # Maximum size of image in megabytes before sending to Telegram as a document.
- image_as_file_size: 10
- # Maximum number of pixels in an image before sending to Telegram as a document. Defaults to 1280x1280 = 1638400.
- image_as_file_pixels: 1638400
- # Enable experimental parallel file transfer, which makes uploads/downloads much faster by
- # streaming from/to Matrix and using many connections for Telegram.
- # Note that generating HQ thumbnails for videos is not possible with streamed transfers.
- # This option uses internal Telethon implementation details and may break with minor updates.
- parallel_file_transfer: false
- # Whether or not created rooms should have federation enabled.
- # If false, created portal rooms will never be federated.
- federate_rooms: true
- # 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
- target: gif
- # Arguments for converter. All converters take width and height.
- args:
- width: 256
- height: 256
- fps: 25 # only for webm and gif (2, 5, 10, 20 or 25 recommended)
- # End-to-bridge encryption support options.
- #
- # See https://docs.mau.fi/bridges/general/end-to-bridge-encryption.html for more info.
- encryption:
- # Allow encryption, work in group chat rooms with e2ee enabled
- allow: {{ env "ENABLE_ENCRYPTION" }}
- # 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
- # Database for the encryption data. If set to `default`, will use the appservice database.
- database: default
- # 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: false
- # 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
- # Whether or not the bridge should send a read receipt from the bridge bot when a message has
- # been sent to Telegram.
- delivery_receipts: false
- # Whether or not delivery errors should be reported as messages in the Matrix room.
- delivery_error_reports: 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
- # When using double puppeting, should muted chats be muted in Matrix?
- mute_bridging: false
- # When using double puppeting, should pinned chats be moved to a specific tag in Matrix?
- # The favorites tag is `m.favourite`.
- pinned_tag: null
- # Same as above for archived chats, the low priority tag is `m.lowpriority`.
- archive_tag: null
- # Whether or not mute status and tags should only be bridged when the portal room is created.
- tag_only_on_create: true
- # Should leaving the room on Matrix make the user leave on Telegram?
- bridge_matrix_leave: true
- # Should the user be kicked out of all portals when logging out of the bridge?
- kick_on_logout: true
- # Should the "* user joined Telegram" notice always be marked as read automatically?
- always_read_joined_telegram_notice: true
- # Settings for backfilling messages from Telegram.
- backfill:
- # Whether or not the Telegram ghosts of logged in Matrix users should be
- # invited to private chats when backfilling history from Telegram. This is
- # usually needed to prevent rate limits and to allow timestamp massaging.
- invite_own_puppet: true
- # Maximum number of messages to backfill without using a takeout.
- # The first time a takeout is used, the user has to manually approve it from a different
- # device. If initial_limit or missed_limit are higher than this value, the bridge will ask
- # the user to accept the takeout after logging in before syncing any chats.
- takeout_limit: 100
- # Maximum number of messages to backfill initially.
- # Set to 0 to disable backfilling when creating portal, or -1 to disable the limit.
- #
- # N.B. Initial backfill will only start after member sync. Make sure your
- # max_initial_member_sync is set to a low enough value so it doesn't take forever.
- initial_limit: 0
- # Maximum number of messages to backfill if messages were missed while the bridge was
- # disconnected. Note that this only works for logged in users and only if the chat isn't
- # older than sync_update_limit
- # Set to 0 to disable backfilling missed messages.
- missed_limit: 50
- # If using double puppeting, should notifications be disabled
- # while the initial backfill is in progress?
- disable_notifications: false
- # Whether or not to enable backfilling in normal groups.
- # Normal groups have numerous technical problems in Telegram, and backfilling normal groups
- # will likely cause problems if there are multiple Matrix users in the group.
- normal_groups: false
-
- # Overrides for base power levels.
- initial_power_level_overrides:
- user: {}
- group: {}
-
- # Whether to bridge Telegram bot messages as m.notices or m.texts.
- bot_messages_as_notices: true
- bridge_notices:
- # Whether or not Matrix bot messages (type m.notice) should be bridged.
- default: false
- # List of user IDs for whom the previous flag is flipped.
- # e.g. if bridge_notices.default is false, notices from other users will not be bridged, but
- # notices from users listed here will be bridged.
- exceptions: []
-
- # An array of possible values for the $distinguisher variable in message formats.
- # Each user gets one of the values here, based on a hash of their user ID.
- # If the array is empty, the $distinguisher variable will also be empty.
- relay_user_distinguishers: ["🟦", "🟣", "🟩", "⭕️", "🔶", "⬛️", "🔵", "🟢"]
- # The formats to use when sending messages to Telegram via the relay bot.
- # Text msgtypes (m.text, m.notice and m.emote) support HTML, media msgtypes don't.
- #
- # Available variables:
- # $sender_displayname - The display name of the sender (e.g. Example User)
- # $sender_username - The username (Matrix ID localpart) of the sender (e.g. exampleuser)
- # $sender_mxid - The Matrix ID of the sender (e.g. @exampleuser:example.com)
- # $distinguisher - A random string from the options in the relay_user_distinguishers array.
- # $message - The message content
- message_formats:
- m.text: "$distinguisher $sender_displayname: $message"
- m.notice: "$distinguisher $sender_displayname: $message"
- m.emote: "* $distinguisher $sender_displayname $message"
- m.file: "$distinguisher $sender_displayname sent a file: $message"
- m.image: "$distinguisher $sender_displayname sent an image: $message"
- m.audio: "$distinguisher $sender_displayname sent an audio file: $message"
- m.video: "$distinguisher $sender_displayname sent a video: $message"
- m.location: "$distinguisher $sender_displayname sent a location: $message"
- # Telegram doesn't have built-in emotes, this field specifies how m.emote's from authenticated
- # users are sent to telegram. All fields in message_formats are supported. Additionally, the
- # Telegram user info is available in the following variables:
- # $displayname - Telegram displayname
- # $username - Telegram username (may not exist)
- # $mention - Telegram @username or displayname mention (depending on which exists)
- emote_format: "* $mention $formatted_body"
-
- # The formats to use when sending state events to Telegram via the relay bot.
- #
- # Variables from `message_formats` that have the `sender_` prefix are available without the prefix.
- # In name_change events, `$prev_displayname` is the previous displayname.
- #
- # Set format to an empty string to disable the messages for that event.
- state_event_formats:
- join: "$distinguisher $displayname joined the room."
- leave: "$distinguisher $displayname left the room."
- name_change: "$distinguisher $prev_displayname changed their name to $distinguisher $displayname"
-
- # Filter rooms that can/can't be bridged. Can also be managed using the `filter` and
- # `filter-mode` management commands.
- #
- # Filters do not affect direct chats.
- # An empty blacklist will essentially disable the filter.
- filter:
- # Filter mode to use. Either "blacklist" or "whitelist".
- # If the mode is "blacklist", the listed chats will never be bridged.
- # If the mode is "whitelist", only the listed chats can be bridged.
- mode: blacklist
- # The list of group/channel IDs to filter.
- list: []
-
- # The prefix for commands. Only required in non-management rooms.
- command_prefix: "!tg"
-
- # Messages sent upon joining a management room.
- # Markdown is supported. The defaults are listed below.
- management_room_text:
- # Sent when joining a room.
- welcome: "Hello, I'm a Telegram bridge bot."
- # Sent when joining a management room and the user is already logged in.
- welcome_connected: "Use `help` for help."
- # Sent when joining a management room and the user is not logged in.
- welcome_unconnected: "Use `help` for help or `login` to log in."
- # Optional extra text sent when joining a management room.
- additional_help: ""
-
- # Send each message separately (for readability in some clients)
- management_room_multiple_messages: false
-
- # Permissions for using the bridge.
- # Permitted values:
- # relaybot - Only use the bridge via the relaybot, no access to commands.
- # user - Relaybot level + access to commands to create bridges.
- # puppeting - User level + logging in with a Telegram account.
- # full - Full access to use the bridge, i.e. previous levels + Matrix login.
- # admin - Full access to use the bridge and some extra administration commands.
- # Permitted keys:
- # * - All Matrix users
- # domain - All users on that homeserver
- # mxid - Specific user
- permissions: {{ env "TELEGRAM_BRIDGE_PERMISSIONS" }}
-
- # Options related to the message relay Telegram bot.
- relaybot:
- private_chat:
- # List of users to invite to the portal when someone starts a private chat with the bot.
- # If empty, private chats with the bot won't create a portal.
- invite: []
- # Whether or not to bridge state change messages in relaybot private chats.
- state_changes: true
- # When private_chat_invite is empty, this message is sent to users /starting the
- # relaybot. Telegram's "markdown" is supported.
- message: This is a Matrix bridge relaybot and does not support direct chats
- # List of users to invite to all group chat portals created by the bridge.
- group_chat_invite: []
- # Whether or not the relaybot should not bridge events in unbridged group chats.
- # If false, portals will be created when the relaybot receives messages, just like normal
- # users. This behavior is usually not desirable, as it interferes with manually bridging
- # the chat to another room.
- ignore_unbridged_group_chat: true
- # Whether or not to allow creating portals from Telegram.
- authless_portals: true
- # Whether or not to allow Telegram group admins to use the bot commands.
- whitelist_group_admins: true
- # Whether or not to ignore incoming events sent by the relay bot.
- ignore_own_incoming_events: true
- # List of usernames/user IDs who are also allowed to use the bot commands.
- whitelist:
- - myusername
- - 12345678
-
-# Telegram config
-telegram:
+# 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" }}
# (Optional) Create your own bot at https://t.me/BotFather
bot_token: {{ secret "telegram_bot_token" }}
-
- # Telethon connection options.
- connection:
- # The timeout in seconds to be used when connecting.
- timeout: 120
- # How many times the reconnection should retry, either on the initial connection or when
- # Telegram disconnects us. May be set to a negative or null value for infinite retries, but
- # this is not recommended, since the program can get stuck in an infinite loop.
- retries: 5
- # The delay in seconds to sleep between automatic reconnections.
- retry_delay: 1
- # The threshold below which the library should automatically sleep on flood wait errors
- # (inclusive). For instance, if a FloodWaitError for 17s occurs and flood_sleep_threshold
- # is 20s, the library will sleep automatically. If the error was for 21s, it would raise
- # the error instead. Values larger than a day (86400) will be changed to a day.
- flood_sleep_threshold: 60
- # How many times a request should be retried. Request are retried when Telegram is having
- # internal issues, when there is a FloodWaitError less than flood_sleep_threshold, or when
- # there's a migrate error. May take a negative or null value for infinite retries, but this
- # is not recommended, since some requests can always trigger a call fail (such as searching
- # for messages).
- request_retries: 5
-
- # Device info sent to Telegram.
+ # Displayname template for Telegram users.
+ # {{ "{{.FullName}}" }} - the full name of the Telegram user
+ # {{ "{{.FirstName}}" }} / {{ "{{.LastName}}" }} - the first/last name
+ # {{ "{{.Username}}" }} - the primary username, 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 }}" }}'
+ # Format for converting animated stickers. disable/png/gif/webm/webp
+ animated_sticker:
+ target: gif
+ args:
+ width: 256
+ height: 256
+ fps: 25
+ # Settings for syncing the member list for portals.
+ member_list:
+ max_initial_sync: 100
+ sync_broadcast_channels: false
+ skip_deleted: true
+ sync:
+ update_limit: 100
+ create_limit: 15
+ login_sync_limit: 15
+ direct_chats: true
+ takeout:
+ dialog_sync: false
+ forward_backfill: false
+ backward_backfill: false
+ max_member_count: -1
+ max_telegram_delete: 100
+ contact_avatars: false
+ contact_names: false
+ always_custom_emoji_reaction: false
+ saved_message_avatar: mxc://maunium.net/XhhfHoPejeneOngMyBbtyWDk
+ always_tombstone_on_supergroup_migration: false
+ image_as_file_pixels: 16777216
+ disable_view_once: false
+ video_url_preview_as_file: false
+ bridge_communities: true
+ # Whether polls should be bridged using unstable MSC3381 event types.
+ # Bridging votes from Telegram is not supported.
+ extev_polls: false
+ # Device info shown in the Telegram device list.
device_info:
- # "auto" = OS name+version.
- device_model: auto
- # "auto" = Telethon version.
- system_version: auto
- # "auto" = mautrix-telegram version.
+ device_model: mautrix-telegram
+ system_version:
app_version: auto
lang_code: en
system_lang_code: en
-
- # Custom server to connect to.
- server:
- # Set to true to use these server settings. If false, will automatically
- # use production server assigned by Telegram. Set to false in production.
- enabled: false
- # The DC ID to connect to.
- dc: 2
- # The IP to connect to.
- ip: 149.154.167.40
- # The port to connect to. 443 may not work, 80 is better and both are equally secure.
- port: 80
-
- # Telethon proxy configuration.
- # You must install PySocks from pip for proxies to work.
proxy:
- # Allowed types: disabled, socks4, socks5, http, mtproxy
type: disabled
- # Proxy IP address and port.
- address: 127.0.0.1
- port: 1080
- # Whether or not to perform DNS resolving remotely. Only for socks/http proxies.
- rdns: true
- # Proxy authentication (optional). Put MTProxy secret in password field.
- username: ""
- password: ""
+ address: "127.0.0.1:1080"
+ username:
+ password:
-# Python logging configuration.
+# Config options that affect the central bridge module.
+bridge:
+ # The prefix for commands. Only required in non-management rooms.
+ command_prefix: "!tg"
+ personal_filtering_spaces: true
+ private_chat_portal_meta: true
+ bridge_matrix_leave: false
+ bridge_notices: false
+ tag_only_on_create: true
+ mute_only_on_create: true
+ cleanup_on_logout:
+ enabled: false
+ manual:
+ private: nothing
+ relayed: nothing
+ shared_no_users: nothing
+ shared_has_users: nothing
+ bad_credentials:
+ private: nothing
+ relayed: nothing
+ shared_no_users: nothing
+ shared_has_users: nothing
+ relay:
+ enabled: false
+ admin_only: true
+ prefer_default: true
+ allow_bridge: true
+ default_relays: []
+ # Permissions for using the bridge.
+ # Permitted values:
+ # relay - Talk through the relay login (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
+ # NOTE: a wildcard-only map is rejected by bridgev2 — include at least one
+ # real domain or mxid entry (e.g. the homeserver domain).
+ 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:?_txlock=immediate` is recommended.
+ # https://github.com/mattn/go-sqlite3#connection-string
+ # Postgres: Connection string. For example, postgres://user:password@host/database?sslmode=disable
+ uri: postgres://telegrambridge:{{ secret "telegram_db_password" }}@telegramdb/telegrambridge?sslmode=disable
+ # Maximum number of connections.
+ max_open_conns: 5
+ max_idle_conns: 1
+ max_conn_idle_time: null
+ max_conn_lifetime: null
+
+# Homeserver details.
+homeserver:
+ # The address that this appservice can use to connect to the homeserver.
+ 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
+ status_endpoint: null
+ message_send_checkpoint_endpoint:
+ async_media: false
+ websocket: false
+ ping_interval_seconds: 0
+
+# 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.
+ address: http://telegrambridge:29317
+ # A public address that external services can use to reach this appservice.
+ # This value doesn't affect the registration file.
+ public_address: https://bridge.example.com
+ # The hostname and port where this appservice should listen.
+ 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" }}"
+ # Whether to receive ephemeral events via appservice transactions.
+ ephemeral_events: true
+ # Should incoming events be handled asynchronously?
+ 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:
+ message_status_events: false
+ delivery_receipts: false
+ message_error_notices: true
+ sync_direct_chat_list: true
+ federate_rooms: true
+
+# Settings for provisioning API
+provisioning:
+ prefix: /_matrix/provision
+ shared_secret: generate
+ allow_matrix_auth: true
+ debug_endpoints: false
+
+# Settings for backfilling messages.
+backfill:
+ enabled: false
+ max_initial_messages: 50
+ max_catchup_messages: 500
+ unread_hours_threshold: 720
+ threads:
+ max_initial_messages: 50
+ queue:
+ enabled: false
+ batch_size: 100
+ batch_delay: 20
+ max_batches: -1
+ max_batches_override: {}
+
+# Settings for enabling double puppeting
+double_puppet:
+ # Servers to always allow double puppeting from.
+ servers:
+ {{ env "HOMESERVER_DOMAIN" }}: {{ env "HOMESERVER_URL" }}
+ allow_discovery: false
+ # Shared secrets for automatic double puppeting
+ # (the shared-secret-auth module on the synapse side).
+ secrets:
+ {{ env "HOMESERVER_DOMAIN" }}: {{ secret "shared_secret_auth" }}
+
+# End-to-bridge encryption support options.
#
-# 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
+# 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
+ require: false
+ appservice: false
+ allow_key_sharing: false
+ pickle_key: generate
+
+# Logging config. See https://github.com/tulir/zeroconfig for details.
+# File logging is deliberately disabled: docker collects stdout, and the
+# synapse entrypoint chowns the shared data volume, so the bridge must not
+# need to write into /data at runtime.
logging:
- version: 1
- formatters:
- colored:
- (): mautrix_telegram.util.ColorFormatter
- format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
- normal:
- format: "[%(asctime)s] [%(levelname)s@%(name)s] %(message)s"
- handlers:
- file:
- class: logging.handlers.RotatingFileHandler
- formatter: normal
- filename: /data/mautrix-telegram.log
- maxBytes: 10485760
- backupCount: 10
- console:
- class: logging.StreamHandler
- formatter: colored
- loggers:
- mau:
- level: ERROR
- telethon:
- level: ERROR
- aiohttp:
- level: ERROR
- root:
- level: ERROR
- handlers: [file, console]
+ min_level: info
+ writers:
+ - type: stdout
+ format: pretty-colored