mirror of
https://github.com/YunoHost-Apps/mautrix_telegram_ynh.git
synced 2024-09-03 19:45:55 +02:00
44 lines
2.6 KiB
Markdown
44 lines
2.6 KiB
Markdown
<!--
|
|
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
|
|
It shall NOT be edited by hand.
|
|
-->
|
|
|
|
# Matrix-Telegram bridge for YunoHost
|
|
|
|
[](https://dash.yunohost.org/appci/app/mautrix_telegram)  
|
|
|
|
[](https://install-app.yunohost.org/?app=mautrix_telegram)
|
|
|
|
*[Read this README in other languages.](./ALL_README.md)*
|
|
|
|
> *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](https://yunohost.org/install) 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"](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.15.1~ynh2
|
|
## 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](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing).
|
|
|
|
To try the `testing` branch, please proceed like that:
|
|
|
|
```bash
|
|
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>
|