YunoHost-Apps/mautrix_telegram_ynh
1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/mautrix_telegram_ynh.git synced 2024-09-03 19:45:55 +02:00
Code Issues Activity Actions 1

Merge pull request #48 from YunoHost-Apps/testing

Browse source 
Testing to master [v0.14.0]
This commit is contained in:
Dante 2023-06-04 16:38:48 +01:00 committed by GitHub
commit f1f5f66b1f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 630 additions and 620 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
.github/workflows/updater.yml vendored
View file

@ -14,7 +14,7 @@ jobs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- name: Fetch the source code - name: Fetch the source code
uses: actions/checkout@v2 uses: actions/checkout@v3
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
- name: Run the updater script - name: Run the updater script
@ -33,7 +33,7 @@ jobs:
- name: Create Pull Request - name: Create Pull Request
id: cpr id: cpr
if: ${{ env.PROCEED == 'true' }} if: ${{ env.PROCEED == 'true' }}
uses: peter-evans/create-pull-request@v3 uses: peter-evans/create-pull-request@v4
with: with:
token: ${{ secrets.GITHUB_TOKEN }} token: ${{ secrets.GITHUB_TOKEN }}
commit-message: Update to version ${{ env.VERSION }} commit-message: Update to version ${{ env.VERSION }}

3
README.md
View file

@ -6,6 +6,7 @@ It shall NOT be edited by hand.
# Matrix-Telegram bridge for YunoHost # Matrix-Telegram bridge for YunoHost
[![Integration level](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![Working status](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg) [![Integration level](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![Working status](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg)
[![Install Matrix-Telegram bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_telegram) [![Install Matrix-Telegram bridge with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_telegram)
*[Lire ce readme en français.](./README_fr.md)* *[Lire ce readme en français.](./README_fr.md)*
@ -18,7 +19,7 @@ If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/in
A puppeting bridge between Matrix and Telegram packaged as a YunoHost service. Messages, notifications (and sometimes media) are bridged between a Telegram user and a Matrix user. Currently the Matrix user can NOT invite other Matrix user in a bridged Telegram room, so only someone with a Telegram account can participate to Telegram group conversations. The ["Mautrix-Telegram"](https://docs.mau.fi/bridges/python/telegram/index.html) bridge is a Synapse App Service and relies on postgresql. Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) should be installed beforehand. A puppeting bridge between Matrix and Telegram packaged as a YunoHost service. Messages, notifications (and sometimes media) are bridged between a Telegram user and a Matrix user. Currently the Matrix user can NOT invite other Matrix user in a bridged Telegram room, so only someone with a Telegram account can participate to Telegram group conversations. The ["Mautrix-Telegram"](https://docs.mau.fi/bridges/python/telegram/index.html) bridge is a Synapse App Service and relies on postgresql. Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) should be installed beforehand.
**Shipped version:** 0.12.2~ynh4 **Shipped version:** 0.14.0~ynh1
## Disclaimers / important information ## Disclaimers / important information
## List of known public services ## List of known public services

19
README_fr.md
View file

@ -5,15 +5,16 @@ It shall NOT be edited by hand.
# Matrix-Telegram bridge pour YunoHost # Matrix-Telegram bridge pour YunoHost
[![Niveau d'intégration](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg) [![Niveau d’intégration](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![Statut du fonctionnement](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![Statut de maintenance](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg)
[![Installer Matrix-Telegram bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_telegram) [![Installer Matrix-Telegram bridge avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=mautrix_telegram)
*[Read this readme in english.](./README.md)* *[Read this readme in english.](./README.md)*
> *Ce package vous permet d'installer Matrix-Telegram bridge rapidement et simplement sur un serveur YunoHost. > *Ce package vous permet d’installer Matrix-Telegram bridge rapidement et simplement sur un serveur YunoHost.
Si vous n'avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l'installer et en profiter.* Si vous n’avez pas YunoHost, regardez [ici](https://yunohost.org/#/install) pour savoir comment l’installer et en profiter.*
## Vue d'ensemble ## Vue d’ensemble
Une passerelle entre Matrix et Telegram empaquetée comme un service YunoHost. Les messages, médias et notifications sont relayées entre un compte Telegram et un compte Matrix. Une passerelle entre Matrix et Telegram empaquetée comme un service YunoHost. Les messages, médias et notifications sont relayées entre un compte Telegram et un compte Matrix.
La passerelle ["Mautrix-Telegram"](https://docs.mau.fi/bridges/python/telegram/index.html) consiste en un Service d'Application Matrix-Synapse et repose sur une base-de-données postgresql. C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) doit être préalablemnet installé. La passerelle ["Mautrix-Telegram"](https://docs.mau.fi/bridges/python/telegram/index.html) consiste en un Service d'Application Matrix-Synapse et repose sur une base-de-données postgresql. C'est pourquoi [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) doit être préalablemnet installé.
@ -21,7 +22,7 @@ La passerelle ["Mautrix-Telegram"](https://docs.mau.fi/bridges/python/telegram/i
** Attention : sauvegardez et restaurez toujours les deux applications Yunohost matrix-synapse et mautrix_telegram en même temps!** ** Attention : sauvegardez et restaurez toujours les deux applications Yunohost matrix-synapse et mautrix_telegram en même temps!**
**Version incluse :** 0.12.2~ynh4 **Version incluse :** 0.14.0~ynh1
## Avertissements / informations importantes ## Avertissements / informations importantes
## Liste de passerelles publiques ## Liste de passerelles publiques
@ -119,10 +120,10 @@ git config --local core.hooksPath .githooks
## Documentations et ressources ## Documentations et ressources
* Site officiel de l'app : <https://docs.mau.fi/bridges/python/telegram/index.html> * Site officiel de l’app : <https://docs.mau.fi/bridges/python/telegram/index.html>
* Documentation officielle utilisateur : <https://docs.mau.fi/bridges/python/telegram/management-commands.html> * Documentation officielle utilisateur : <https://docs.mau.fi/bridges/python/telegram/management-commands.html>
* Documentation officielle de l'admin : <https://github.com/YunoHost-Apps/mautrix_telegram_ynh> * Documentation officielle de l’admin : <https://github.com/YunoHost-Apps/mautrix_telegram_ynh>
* Dépôt de code officiel de l'app : <https://github.com/mautrix/telegram> * Dépôt de code officiel de l’app : <https://github.com/mautrix/telegram>
* Documentation YunoHost pour cette app : <https://yunohost.org/app_mautrix_telegram> * Documentation YunoHost pour cette app : <https://yunohost.org/app_mautrix_telegram>
* Signaler un bug : <https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues> * Signaler un bug : <https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues>
@ -138,4 +139,4 @@ ou
sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug
``` ```
**Plus d'infos sur le packaging d'applications :** <https://yunohost.org/packaging_apps> **Plus d’infos sur le packaging d’applications :** <https://yunohost.org/packaging_apps>

4
conf/app.src
View file

@ -1,5 +1,5 @@
SOURCE_URL=https://github.com/mautrix/telegram/archive/refs/tags/v0.12.2.tar.gz SOURCE_URL=https://github.com/mautrix/telegram/archive/refs/tags/v0.14.0.tar.gz
SOURCE_SUM=a25e298db1d0de7113eb6f047e2862fc737c5ee8545473cb7e4fe8b8260eaab9 SOURCE_SUM=95a2a73f942bc4a932ef2b7029333e272a23b0e9ec0d5bccb5531e8004370f10
SOURCE_SUM_PRG=sha256sum SOURCE_SUM_PRG=sha256sum
SOURCE_FORMAT=tar.gz SOURCE_FORMAT=tar.gz
SOURCE_IN_SUBDIR=true SOURCE_IN_SUBDIR=true

94
conf/config.yaml
View file

@ -21,7 +21,6 @@ homeserver:
# Whether asynchronous uploads via MSC2246 should be enabled for media. # Whether asynchronous uploads via MSC2246 should be enabled for media.
# Requires a media repo that supports MSC2246. # Requires a media repo that supports MSC2246.
async_media: false async_media: false
# Application service host/registration related details # Application service host/registration related details
# Changing these values requires regeneration of the registration. # Changing these values requires regeneration of the registration.
appservice: appservice:
@ -30,14 +29,12 @@ appservice:
# When using https:// the TLS certificate and key files for the address. # When using https:// the TLS certificate and key files for the address.
tls_cert: false tls_cert: false
tls_key: false tls_key: false
# The hostname and port where this appservice should listen. # The hostname and port where this appservice should listen.
hostname: 0.0.0.0 hostname: 0.0.0.0
port: __PORT__ port: __PORT__
# The maximum body size of appservice API requests (from the homeserver) in mebibytes # 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 # Usually 1 is enough, but on high-traffic bridges you might need to increase this to avoid 413s
max_body_size: 1 max_body_size: 1
# The full URI to the database. SQLite and Postgres are supported. # The full URI to the database. SQLite and Postgres are supported.
# Format examples: # Format examples:
# SQLite: sqlite:///filename.db # SQLite: sqlite:///filename.db
@ -49,7 +46,6 @@ appservice:
# For sqlite, min_size is used as the connection thread pool size and max_size is ignored. # For sqlite, min_size is used as the connection thread pool size and max_size is ignored.
# Additionally, SQLite supports init_commands as an array of SQL queries to run on connect (e.g. to set PRAGMAs). # Additionally, SQLite supports init_commands as an array of SQL queries to run on connect (e.g. to set PRAGMAs).
database_opts: {} database_opts: {}
# Public part of web server for out-of-Matrix interaction with the bridge. # 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 # Used for things like login if the user wants to make sure the 2FA password isn't stored in
# the HS database. # the HS database.
@ -61,7 +57,6 @@ appservice:
# The base URL where the public-facing endpoints are available. The prefix is not added # The base URL where the public-facing endpoints are available. The prefix is not added
# implicitly. # implicitly.
external: https://example.com/public external: https://example.com/public
# Provisioning API part of the web server for automated portal creation and fetching information. # 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). # Used by things like mautrix-manager (https://github.com/tulir/mautrix-manager).
provisioning: provisioning:
@ -72,7 +67,6 @@ appservice:
# The shared secret to authorize users of the API. # The shared secret to authorize users of the API.
# Set to "generate" to generate and save a new token. # Set to "generate" to generate and save a new token.
shared_secret: generate shared_secret: generate
# The unique ID of this appservice. # The unique ID of this appservice.
id: __APPSERVICEID__ id: __APPSERVICEID__
# Username of the appservice bot. # Username of the appservice bot.
@ -81,21 +75,17 @@ appservice:
# to leave display name/avatar as-is. # to leave display name/avatar as-is.
bot_displayname: Telegram bridge bot bot_displayname: Telegram bridge bot
bot_avatar: mxc://maunium.net/tJCRmUyJDsgRNgqhOgoiHWbX bot_avatar: mxc://maunium.net/tJCRmUyJDsgRNgqhOgoiHWbX
# Whether or not to receive ephemeral events via appservice transactions. # Whether or not to receive ephemeral events via appservice transactions.
# Requires MSC2409 support (i.e. Synapse 1.22+). # Requires MSC2409 support (i.e. Synapse 1.22+).
# You should disable bridge -> sync_with_custom_puppets when this is enabled. # You should disable bridge -> sync_with_custom_puppets when this is enabled.
ephemeral_events: false ephemeral_events: false
# Authentication tokens for AS <-> HS communication. Autogenerated; do not modify. # Authentication tokens for AS <-> HS communication. Autogenerated; do not modify.
as_token: __AS_TOKEN__ as_token: __AS_TOKEN__
hs_token: __HS_TOKEN__ hs_token: __HS_TOKEN__
# Prometheus telemetry config. Requires prometheus-client to be installed. # Prometheus telemetry config. Requires prometheus-client to be installed.
metrics: metrics:
enabled: false enabled: false
listen_port: 8000 listen_port: 8000
# Manhole config. # Manhole config.
manhole: manhole:
# Whether or not opening the manhole is allowed. # Whether or not opening the manhole is allowed.
@ -106,7 +96,6 @@ manhole:
# If empty, any UIDs can be specified in the open-manhole command. # If empty, any UIDs can be specified in the open-manhole command.
whitelist: whitelist:
- 0 - 0
# Bridge config # Bridge config
bridge: bridge:
# Localpart template of MXIDs for Telegram users. # Localpart template of MXIDs for Telegram users.
@ -118,7 +107,6 @@ bridge:
# Displayname template for Telegram users. # Displayname template for Telegram users.
# {displayname} is replaced with the display name of the Telegram user. # {displayname} is replaced with the display name of the Telegram user.
displayname_template: "{displayname} (Telegram)" displayname_template: "{displayname} (Telegram)"
# Set the preferred order of user identifiers which to use in the Matrix puppet display name. # 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 # In the (hopefully unlikely) scenario that none of the given keys are found, the numeric user
# ID is used. # ID is used.
@ -143,7 +131,9 @@ bridge:
# as there's no way to determine whether an avatar is removed or just hidden from some users. If # 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. # you're on a single-user instance, this should be safe to enable.
allow_avatar_remove: false allow_avatar_remove: false
# Should contact names and profile pictures be allowed?
# This is only safe to enable on single-user instances.
allow_contact_info: false
# Maximum number of members to sync per portal when starting up. Other members will be # 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 # synced when they send messages. The maximum is 10000, after which the Telegram server
# will not send any more members. # will not send any more members.
@ -269,6 +259,23 @@ bridge:
# Enable key sharing? If enabled, key requests for rooms where users are in will be fulfilled. # 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. # You must use a client that supports requesting keys from other users to use this feature.
allow_key_sharing: false allow_key_sharing: false
# 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
# What level of device verification should be required from users? # What level of device verification should be required from users?
# #
# Valid levels: # Valid levels:
@ -303,15 +310,21 @@ bridge:
# session before changing it. The Matrix spec recommends 100 as the # session before changing it. The Matrix spec recommends 100 as the
# default. # default.
messages: 100 messages: 100
# Whether to explicitly set the avatar and room name for private chat portal rooms.
# Whether or not to explicitly set the avatar and room name for private # If set to `default`, this will be enabled in encrypted rooms and disabled in unencrypted rooms.
# chat portal rooms. This will be implicitly enabled if encryption.default is true. # If set to `always`, all DM rooms will have explicit names and avatars set.
private_chat_portal_meta: false # If set to `never`, DM rooms will never have names and avatars set.
private_chat_portal_meta: default
# Disable generating reply fallbacks? Some extremely bad clients still rely on them,
# but they're being phased out and will be completely removed in the future.
disable_reply_fallbacks: false
# Whether or not the bridge should send a read receipt from the bridge bot when a message has # Whether or not the bridge should send a read receipt from the bridge bot when a message has
# been sent to Telegram. # been sent to Telegram.
delivery_receipts: false delivery_receipts: false
# Whether or not delivery errors should be reported as messages in the Matrix room. # Whether or not delivery errors should be reported as messages in the Matrix room.
delivery_error_reports: false delivery_error_reports: false
# Should errors in incoming message handling send a message to the Matrix room?
incoming_bridge_error_reports: false
# Whether the bridge should send the message status as a custom com.beeper.message_send_status event. # Whether the bridge should send the message status as a custom com.beeper.message_send_status event.
message_status_events: false message_status_events: false
# Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run. # Set this to true to tell the bridge to re-send m.bridge events to all rooms on the next run.
@ -353,26 +366,34 @@ bridge:
# Even without MSC2716, bridging old messages with correct timestamps requires the double # Even without MSC2716, bridging old messages with correct timestamps requires the double
# puppets to be in an appservice namespace, or the server to be modified to allow # puppets to be in an appservice namespace, or the server to be modified to allow
# overriding timestamps anyway. # overriding timestamps anyway.
#
# Also note that adding users to the appservice namespace may have unexpected side effects,
# as described in https://docs.mau.fi/bridges/general/double-puppeting.html#appservice-method
double_puppet_backfill: false double_puppet_backfill: false
# Whether or not to enable backfilling in normal groups. # Whether or not to enable backfilling in normal groups.
# Normal groups have numerous technical problems in Telegram, and backfilling 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. # will likely cause problems if there are multiple Matrix users in the group.
normal_groups: false normal_groups: false
# If a backfilled chat is older than this number of hours, mark it as read even if it's unread on Telegram. # If a backfilled chat is older than this number of hours, mark it as read even if it's unread on Telegram.
# Set to -1 to let any chat be unread. # Set to -1 to let any chat be unread.
unread_hours_threshold: 720 unread_hours_threshold: 720
# Forward backfilling limits. These apply to both MSC2716 and legacy backfill. # Forward backfilling limits. These apply to both MSC2716 and legacy backfill.
# #
# Using a negative initial limit is not recommended, as it would try to backfill everything in a single batch. # Using a negative initial limit is not recommended, as it would try to backfill everything in a single batch.
# MSC2716 and the incremental settings are meant for backfilling everything incrementally rather than at once. # MSC2716 and the incremental settings are meant for backfilling everything incrementally rather than at once.
forward: forward_limits:
# Number of messages to backfill immediately after creating a portal. # Number of messages to backfill immediately after creating a portal.
initial_limit: 10 initial:
user: 50
normal_group: 100
supergroup: 10
channel: 10
# Number of messages to backfill when syncing chats. # Number of messages to backfill when syncing chats.
sync_limit: 100 sync:
user: 100
normal_group: 100
supergroup: 100
channel: 100
# Settings for incremental backfill of history. These only apply when using MSC2716. # Settings for incremental backfill of history. These only apply when using MSC2716.
incremental: incremental:
# Maximum number of messages to backfill per batch. # Maximum number of messages to backfill per batch.
@ -391,12 +412,10 @@ bridge:
supergroup: 10 supergroup: 10
# Broadcast channels # Broadcast channels
channel: -1 channel: -1
# Overrides for base power levels. # Overrides for base power levels.
initial_power_level_overrides: initial_power_level_overrides:
user: {} user: {}
group: {} group: {}
# Whether to bridge Telegram bot messages as m.notices or m.texts. # Whether to bridge Telegram bot messages as m.notices or m.texts.
bot_messages_as_notices: true bot_messages_as_notices: true
bridge_notices: bridge_notices:
@ -406,11 +425,10 @@ bridge:
# e.g. if bridge_notices.default is false, notices from other users will not be bridged, but # 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. # notices from users listed here will be bridged.
exceptions: [] exceptions: []
# An array of possible values for the $distinguisher variable in message formats. # 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. # 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. # If the array is empty, the $distinguisher variable will also be empty.
relay_user_distinguishers: ["🟦", "🟣", "🟩", "⭕️", "🔶", "⬛️", "🔵", "🟢"] relay_user_distinguishers: ["\U0001F7E6", "\U0001F7E3", "\U0001F7E9", "⭕️", "\U0001F536", "⬛️", "\U0001F535", "\U0001F7E2"]
# The formats to use when sending messages to Telegram via the relay bot. # 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. # Text msgtypes (m.text, m.notice and m.emote) support HTML, media msgtypes don't.
# #
@ -436,7 +454,6 @@ bridge:
# $username - Telegram username (may not exist) # $username - Telegram username (may not exist)
# $mention - Telegram @username or displayname mention (depending on which exists) # $mention - Telegram @username or displayname mention (depending on which exists)
emote_format: "* $mention $formatted_body" emote_format: "* $mention $formatted_body"
# The formats to use when sending state events to Telegram via the relay bot. # 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. # Variables from `message_formats` that have the `sender_` prefix are available without the prefix.
@ -447,11 +464,9 @@ bridge:
join: "$distinguisher <b>$displayname</b> joined the room." join: "$distinguisher <b>$displayname</b> joined the room."
leave: "$distinguisher <b>$displayname</b> left the room." leave: "$distinguisher <b>$displayname</b> left the room."
name_change: "$distinguisher <b>$prev_displayname</b> changed their name to $distinguisher <b>$displayname</b>" name_change: "$distinguisher <b>$prev_displayname</b> changed their name to $distinguisher <b>$displayname</b>"
# Filter rooms that can/can't be bridged. Can also be managed using the `filter` and # Filter rooms that can/can't be bridged. Can also be managed using the `filter` and
# `filter-mode` management commands. # `filter-mode` management commands.
# #
# Filters do not affect direct chats.
# An empty blacklist will essentially disable the filter. # An empty blacklist will essentially disable the filter.
filter: filter:
# Filter mode to use. Either "blacklist" or "whitelist". # Filter mode to use. Either "blacklist" or "whitelist".
@ -460,10 +475,13 @@ bridge:
mode: blacklist mode: blacklist
# The list of group/channel IDs to filter. # The list of group/channel IDs to filter.
list: [] list: []
# How to handle direct chats:
# If users is "null", direct chats will follow the previous settings.
# If users is "true", direct chats will always be bridged.
# If users is "false", direct chats will never be bridged.
users: true
# The prefix for commands. Only required in non-management rooms. # The prefix for commands. Only required in non-management rooms.
command_prefix: "!tg" command_prefix: "!tg"
# Messages sent upon joining a management room. # Messages sent upon joining a management room.
# Markdown is supported. The defaults are listed below. # Markdown is supported. The defaults are listed below.
management_room_text: management_room_text:
@ -475,10 +493,8 @@ bridge:
welcome_unconnected: "Use `help` for help or `login` to log in." welcome_unconnected: "Use `help` for help or `login` to log in."
# Optional extra text sent when joining a management room. # Optional extra text sent when joining a management room.
additional_help: "" additional_help: ""
# Send each message separately (for readability in some clients) # Send each message separately (for readability in some clients)
management_room_multiple_messages: false management_room_multiple_messages: false
# Permissions for using the bridge. # Permissions for using the bridge.
# Permitted values: # Permitted values:
# relaybot - Only use the bridge via the relaybot, no access to commands. # relaybot - Only use the bridge via the relaybot, no access to commands.
@ -494,7 +510,6 @@ bridge:
"*": "relaybot" "*": "relaybot"
"__BOTUSERS__": "puppeting" "__BOTUSERS__": "puppeting"
"__BOTADMIN__": "admin" "__BOTADMIN__": "admin"
# Options related to the message relay Telegram bot. # Options related to the message relay Telegram bot.
relaybot: relaybot:
private_chat: private_chat:
@ -520,8 +535,7 @@ bridge:
# Whether or not to ignore incoming events sent by the relay bot. # Whether or not to ignore incoming events sent by the relay bot.
ignore_own_incoming_events: true ignore_own_incoming_events: true
# List of usernames/user IDs who are also allowed to use the bot commands. # List of usernames/user IDs who are also allowed to use the bot commands.
whitelist: [] whitelist: {}
# Telegram config # Telegram config
telegram: telegram:
# Get your own API keys at https://my.telegram.org/apps # Get your own API keys at https://my.telegram.org/apps
@ -529,13 +543,11 @@ telegram:
api_hash: __APIHASH__ api_hash: __APIHASH__
# (Optional) Create your own bot at https://t.me/BotFather # (Optional) Create your own bot at https://t.me/BotFather
bot_token: __BOTTOKEN__ bot_token: __BOTTOKEN__
# Should the bridge request missed updates from Telegram when restarting? # Should the bridge request missed updates from Telegram when restarting?
catch_up: true catch_up: true
# Should incoming updates be handled sequentially to make sure order is preserved on Matrix? # Should incoming updates be handled sequentially to make sure order is preserved on Matrix?
sequential_updates: true sequential_updates: true
exit_on_update_error: false exit_on_update_error: false
# Telethon connection options. # Telethon connection options.
connection: connection:
# The timeout in seconds to be used when connecting. # The timeout in seconds to be used when connecting.
@ -557,7 +569,6 @@ telegram:
# is not recommended, since some requests can always trigger a call fail (such as searching # is not recommended, since some requests can always trigger a call fail (such as searching
# for messages). # for messages).
request_retries: 5 request_retries: 5
# Device info sent to Telegram. # Device info sent to Telegram.
device_info: device_info:
# "auto" = OS name+version. # "auto" = OS name+version.
@ -568,7 +579,6 @@ telegram:
app_version: auto app_version: auto
lang_code: en lang_code: en
system_lang_code: en system_lang_code: en
# Custom server to connect to. # Custom server to connect to.
server: server:
# Set to true to use these server settings. If false, will automatically # Set to true to use these server settings. If false, will automatically
@ -580,7 +590,6 @@ telegram:
ip: 149.154.167.40 ip: 149.154.167.40
# The port to connect to. 443 may not work, 80 is better and both are equally secure. # The port to connect to. 443 may not work, 80 is better and both are equally secure.
port: 80 port: 80
# Telethon proxy configuration. # Telethon proxy configuration.
# You must install PySocks from pip for proxies to work. # You must install PySocks from pip for proxies to work.
proxy: proxy:
@ -594,7 +603,6 @@ telegram:
# Proxy authentication (optional). Put MTProxy secret in password field. # Proxy authentication (optional). Put MTProxy secret in password field.
username: "" username: ""
password: "" password: ""
# Python logging configuration. # Python logging configuration.
# #
# See section 16.7.2 of the Python documentation for more info: # See section 16.7.2 of the Python documentation for more info:

2
manifest.json
View file

@ -6,7 +6,7 @@
"en": "Telegram puppeting bridge for Matrix/Synapse", "en": "Telegram puppeting bridge for Matrix/Synapse",
"fr": "Passerelle Telegram pour Matrix/Synapse" "fr": "Passerelle Telegram pour Matrix/Synapse"
}, },
"version": "0.12.2~ynh4", "version": "0.14.0~ynh1",
"url": "https://docs.mau.fi/bridges/python/telegram/index.html", "url": "https://docs.mau.fi/bridges/python/telegram/index.html",
"upstream": { "upstream": {
"license": "AGPL-3.0-or-later", "license": "AGPL-3.0-or-later",