mirror of https://github.com/YunoHost-Apps/mautrix_telegram_ynh.git synced 2024-09-03 19:45:55 +02:00

Matrix Telegram pupetting bridge for YunoHost

Find a file

yunohost-bot fb913879c3 Auto-update READMEs		2024-07-17 06:28:22 +00:00
.githooks	Enhance updater.sh script to also update config.yaml file and add git hook	2022-12-02 15:40:16 +00:00
.github	Packaging v2	2023-11-13 21:39:37 +01:00
conf	Upgrade to v0.15.2	2024-07-17 06:28:17 +00:00
doc	Add PREUPGRADE notices	2023-12-12 11:21:10 +00:00
scripts	[autopatch] Do not delete logs on app removal (#69 )	2024-06-24 10:42:30 +02:00
ALL_README.md	Auto-update READMEs	2024-06-09 21:31:00 +00:00
config_panel.toml	Update config_panel.toml - helptext should be a sub-key	2024-06-10 10:45:23 +02:00
LICENSE	Fix linter warnings	2021-09-05 14:24:10 +02:00
manifest.toml	Upgrade to v0.15.2	2024-07-17 06:28:17 +00:00
README.md	Auto-update READMEs	2024-07-17 06:28:22 +00:00
README_es.md	Auto-update READMEs	2024-07-17 06:28:22 +00:00
README_eu.md	Auto-update READMEs	2024-07-17 06:28:22 +00:00
README_fr.md	Auto-update READMEs	2024-07-17 06:28:22 +00:00
README_gl.md	Auto-update READMEs	2024-07-17 06:28:22 +00:00
README_it.md	Auto-update README	2024-03-29 07:12:34 +01:00
README_zh_Hans.md	Auto-update READMEs	2024-07-17 06:28:22 +00:00
tests.toml	Update tests.toml: update synapse install now that it's on packaging v2	2024-04-16 16:54:29 +02:00

README.md

Matrix-Telegram bridge for YunoHost

Read this README in other languages.

This package allows you to install Matrix-Telegram bridge quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult the guide to learn how to install it.

Overview

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" bridge is a Synapse App Service and relies on postgresql. Therefore, Synapse for YunoHost should be installed beforehand.

Shipped version: 0.15.2~ynh1

Documentation and resources

Official app website: https://docs.mau.fi/bridges/python/telegram/index.html
Official user documentation: https://docs.mau.fi/bridges/python/telegram/management-commands.html
Official admin documentation: https://github.com/YunoHost-Apps/mautrix_telegram_ynh
Upstream app code repository: https://github.com/mautrix/telegram
YunoHost Store: https://apps.yunohost.org/app/mautrix_telegram
Report a bug: https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues

Developer info

Please send your pull request to the testing branch.

To try the testing branch, please proceed like that:

sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug
or
sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug

More info regarding app packaging: https://yunohost.org/packaging_apps