mirror of
https://github.com/YunoHost-Apps/mautrix_telegram_ynh.git
synced 2024-09-03 19:45:55 +02:00
make linter even more happy
This commit is contained in:
parent
496910b94e
commit
65e4ef8253
7 changed files with 206 additions and 82 deletions
67
README.md
67
README.md
|
@ -1,24 +1,23 @@
|
|||
# A Matrix-Telegram puppeting bridge for YunoHost
|
||||
<!--
|
||||
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
|
||||
|
||||
[![Integration level](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.maintain.svg)
|
||||
[![Install Mautrix-Telegram 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)*
|
||||
|
||||
> *This package allows you to install Mautrix-Telegram quickly and simply on a YunoHost server.
|
||||
> *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 consists in a Synapse App Service and relies on postgresql (mysql also possible). Therefore, [Synapse for YunoHost](https://github.com/YunoHost-Apps/synapse_ynh) should be installed beforehand.
|
||||
|
||||
**Shipped version:** 0.1.0
|
||||
|
||||
## Screenshots
|
||||
|
||||
![](Link to a screenshot of this app.)
|
||||
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.
|
||||
|
||||
## List of known public services
|
||||
|
||||
* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #telegram:maunium.net
|
||||
|
||||
## Bridging usage
|
||||
|
@ -36,6 +35,7 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/
|
|||
* follow setup instructions from bot
|
||||
* By defaults, only conversations with very recent messages and groups will be suggested to be bridged
|
||||
* Accept invitations to the bridged chat rooms
|
||||
|
||||
#### Registering the Bridge as a primary device (untested)
|
||||
* Type ``!tg register <phone>``, where ``<phone>`` is your phone number in the internation format with no space, e.g. ``!tg register +33612345678``
|
||||
* Answer in the bot room with the verification code that you reveived in SMS.
|
||||
|
@ -47,16 +47,23 @@ See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/
|
|||
|
||||
|
||||
### Relaybot: Bridge a group for several Matrix and several Telegram users to chat together
|
||||
Not yet available
|
||||
* see https://docs.mau.fi/bridges/python/telegram/relay-bot.html
|
||||
|
||||
## Configuration of the bridge
|
||||
|
||||
**Shipped version:** 0.10.1~ynh3
|
||||
|
||||
|
||||
|
||||
## Disclaimers / important information
|
||||
|
||||
### Configuration of the bridge
|
||||
|
||||
The bridge is [roughly configured at installation](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/blob/master/conf/config.yaml), e.g. allowed admin and user of the bot. Finer configuration can be done by modifying the
|
||||
following configuration file with SSH:
|
||||
```/opt/yunohost/mautrix_telegram/config.yaml```
|
||||
and then restarting the mautrix_telegram service.
|
||||
|
||||
## Documentation
|
||||
### Documentation
|
||||
|
||||
* Official "Mautrix-Telegram" documentation: https://docs.mau.fi/bridges/python/telegram/index.html
|
||||
* Matrix room (Matrix Bridges in Yunohost): #mautrix_yunohost:matrix.fdn.fr
|
||||
|
@ -66,8 +73,6 @@ In case you need to upload your logs somewhere, be aware that they contain your
|
|||
* "Mautrix-Telegram" bridge is based on the [telegram daemon](https://gitlab.com/telegramd/telegramd) project.
|
||||
* YunoHost documentation: If more specific documentation is needed, feel free to contribute.
|
||||
|
||||
## YunoHost specific features
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
* Bot users are not related to Yunohost users. Any Matrix account or Synapse server autorized in the configuration of the bridge can invite/use the bot.
|
||||
|
@ -87,7 +92,7 @@ In case you need to upload your logs somewhere, be aware that they contain your
|
|||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_telegram/)
|
||||
|
||||
|
||||
## Troubleshooting
|
||||
### Troubleshooting
|
||||
|
||||
* Check the spelling of the bot name!
|
||||
* For slow servers it might be necessary to run ``systemctl edit mautrix_telegram.service`` (also for `coturn.service` and `coturn-synapse.service`) and insert
|
||||
|
@ -98,27 +103,17 @@ ExecStartPre=/bin/sleep 90
|
|||
such that it is ensured that synapse is running before the bridge tries to connect.
|
||||
(If it worked after installation but broke after a restart this probably is it.)
|
||||
|
||||
## Additional information
|
||||
## Documentation and resources
|
||||
|
||||
* Other info you would like to add about this app.
|
||||
|
||||
**More info on the documentation page:**
|
||||
https://docs.mau.fi/bridges/python/telegram/index.html
|
||||
|
||||
## Links
|
||||
|
||||
* Report a bug: https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues
|
||||
* App website: https://github.com/YunoHost-Apps/mautrix-whatsapp_ynh
|
||||
* Upstream app documentation: https://docs.mau.fi/bridges/python/telegram/index.html
|
||||
* Upstream app repository: https://github.com/mautrix/telegram
|
||||
* Up-Upstream repository: https://gitlab.com/telegramd/telegramd
|
||||
* YunoHost website: https://yunohost.org/
|
||||
|
||||
---
|
||||
* 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 documentation for this app: https://yunohost.org/app_mautrix_telegram
|
||||
* Report a bug: https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues
|
||||
|
||||
## Developer info
|
||||
|
||||
**Only if you want to use a testing branch for coding, instead of merging directly into master.**
|
||||
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.
|
||||
|
@ -128,8 +123,4 @@ or
|
|||
sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug
|
||||
```
|
||||
|
||||
To test communication between the App Service and Matrix-Synapse on a VM (e.g. with domain name: synapse.vm), you must install a certificate:
|
||||
```
|
||||
echo | openssl s_client -showcerts -servername synapse.vm -connect synapse.vm:443 2>/dev/null | awk '/-----BEGIN CERTIFICATE-----/, /-----END CERTIFICATE-----/' >> /usr/local/share/ca-certificates/synapse.vm.crt
|
||||
update-ca-certificates
|
||||
```
|
||||
**More info regarding app packaging:** https://yunohost.org/packaging_apps
|
125
README_fr.md
125
README_fr.md
|
@ -1,75 +1,122 @@
|
|||
# App exemple pour YunoHost
|
||||
# Matrix-Telegram bridge pour YunoHost
|
||||
|
||||
[![Niveau d'intégration](https://dash.yunohost.org/integration/REPLACEBYYOURAPP.svg)](https://dash.yunohost.org/appci/app/REPLACEBYYOURAPP) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.status.svg) ![](https://ci-apps.yunohost.org/ci/badges/REPLACEBYYOURAPP.maintain.svg)
|
||||
[![Installer REPLACEBYYOURAPP avec YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=REPLACEBYYOURAPP)
|
||||
[![Niveau d'intégration](https://dash.yunohost.org/integration/mautrix_telegram.svg)](https://dash.yunohost.org/appci/app/mautrix_telegram) ![](https://ci-apps.yunohost.org/ci/badges/mautrix_telegram.status.svg) ![](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)
|
||||
|
||||
*[Read this readme in english.](./README.md)*
|
||||
*[Lire ce readme en français.](./README_fr.md)*
|
||||
|
||||
> *Ce package vous permet d'installer REPLACEBYYOURAPP rapidement et simplement sur un serveur YunoHost.
|
||||
Si vous n'avez pas YunoHost, consultez [le guide](https://yunohost.org/#/install) pour apprendre comment l'installer.*
|
||||
> *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.*
|
||||
|
||||
## Vue d'ensemble
|
||||
Description rapide de cette application.
|
||||
|
||||
**Version incluse :** 1.0
|
||||
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.
|
||||
|
||||
## Captures d'écran
|
||||
## List of known public services
|
||||
* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #telegram:maunium.net
|
||||
|
||||
![](Lien vers une capture d'écran de cette application.)
|
||||
## Bridging usage
|
||||
** Note that several Telegram and Matrix users can be bridged, each Telegram account has its own bot administration room. If they are in a same Telegram group, only one matrix room will be created. **
|
||||
|
||||
## Démo
|
||||
### Bridge a Telegram user and a Matrix user
|
||||
* First your Matrix user or Synapse Server has to be authorized in the Configuration of the bridge (see below)
|
||||
* Then, invite the bot (default @telegrambot:yoursynapse.domain) in this new Mautrix-Telegram bot administration room.
|
||||
* If the Bot does bot accept, see the [troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html)
|
||||
* Send ``!tg help`` to the bot in the created room to know how to control the bot.
|
||||
See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/telegram/authentication.html)
|
||||
|
||||
* [Démo officielle](Lien vers un site de démonstration de cette application.)
|
||||
#### Logging into Telegram account
|
||||
* Type ``login`` or ``login-qr`` (untested) in main management room (`!tg` in any bridge room)
|
||||
* follow setup instructions from bot
|
||||
* By defaults, only conversations with very recent messages and groups will be suggested to be bridged
|
||||
* Accept invitations to the bridged chat rooms
|
||||
|
||||
## Configuration
|
||||
#### Registering the Bridge as a primary device (untested)
|
||||
* Type ``!tg register <phone>``, where ``<phone>`` is your phone number in the internation format with no space, e.g. ``!tg register +33612345678``
|
||||
* Answer in the bot room with the verification code that you reveived in SMS.
|
||||
* Set a profile name with ``!tg set-profile-name <name>``
|
||||
|
||||
Comment configurer cette application : via le panneau d'administration, un fichier brut en SSH ou tout autre moyen.
|
||||
### Double puppeting
|
||||
* Log in with ``login-matrix <access token>``
|
||||
* After logging in, the default Matrix puppet of your Telegram account should leave rooms and your account should join all rooms the puppet was in automatically.
|
||||
|
||||
## Documentation
|
||||
|
||||
* Documentation officielle : Lien vers la documentation officielle de cette application.
|
||||
* Documentation YunoHost : Si une documentation spécifique est nécessaire, n'hésitez pas à contribuer.
|
||||
### Relaybot: Bridge a group for several Matrix and several Telegram users to chat together
|
||||
* see https://docs.mau.fi/bridges/python/telegram/relay-bot.html
|
||||
|
||||
## Caractéristiques spécifiques YunoHost
|
||||
|
||||
#### Support multi-utilisateur
|
||||
**Version incluse :** 0.10.1~ynh3
|
||||
|
||||
* L'authentification LDAP et HTTP est-elle prise en charge ?
|
||||
* L'application peut-elle être utilisée par plusieurs utilisateurs ?
|
||||
|
||||
#### Architectures supportées
|
||||
|
||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/REPLACEBYYOURAPP%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/REPLACEBYYOURAPP/)
|
||||
## Avertissements / informations importantes
|
||||
|
||||
## Limitations
|
||||
### Configuration of the bridge
|
||||
|
||||
* Limitations connues.
|
||||
The bridge is [roughly configured at installation](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/blob/master/conf/config.yaml), e.g. allowed admin and user of the bot. Finer configuration can be done by modifying the
|
||||
following configuration file with SSH:
|
||||
```/opt/yunohost/mautrix_telegram/config.yaml```
|
||||
and then restarting the mautrix_telegram service.
|
||||
|
||||
## Informations additionnelles
|
||||
### Documentation
|
||||
|
||||
* Autres informations que vous souhaitez ajouter sur cette application.
|
||||
* Official "Mautrix-Telegram" documentation: https://docs.mau.fi/bridges/python/telegram/index.html
|
||||
* Matrix room (Matrix Bridges in Yunohost): #mautrix_yunohost:matrix.fdn.fr
|
||||
* Matrix room (upstream app): #telegram:maunium.net
|
||||
In case you need to upload your logs somewhere, be aware that they contain your contacts' and your phone numbers. Strip them out with
|
||||
``| sed -r 's/[0-9]{10,}/📞/g' ``
|
||||
* "Mautrix-Telegram" bridge is based on the [telegram daemon](https://gitlab.com/telegramd/telegramd) project.
|
||||
* YunoHost documentation: If more specific documentation is needed, feel free to contribute.
|
||||
|
||||
**Plus d'informations sur la page de documentation :**
|
||||
https://yunohost.org/packaging_apps
|
||||
#### Multi-user support
|
||||
|
||||
## Liens
|
||||
* Bot users are not related to Yunohost users. Any Matrix account or Synapse server autorized in the configuration of the bridge can invite/use the bot.
|
||||
* The Telegram bot is a local Matrix-Synapse user, but accessible through federation (synapse public or private).
|
||||
* Several Telegram and Matrix users can be bridged with one bridge, each user has its own bot administration room.
|
||||
* If several bot users are in a same Telegram group, only one Matrix room will be created by the bridge.
|
||||
* See https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
|
||||
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/issues
|
||||
* Site de l'application : Lien vers le site officiel de cette application.
|
||||
* Dépôt de l'application principale : Lien vers le dépôt officiel de l'application principale.
|
||||
* Site web YunoHost : https://yunohost.org/
|
||||
#### Multi-instance support
|
||||
|
||||
---
|
||||
* Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several Telegram accounts.
|
||||
* Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mautrix_telegram/)
|
||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_telegram/)
|
||||
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
* Check the spelling of the bot name!
|
||||
* For slow servers it might be necessary to run ``systemctl edit mautrix_telegram.service`` (also for `coturn.service` and `coturn-synapse.service`) and insert
|
||||
```
|
||||
[Service]
|
||||
ExecStartPre=/bin/sleep 90
|
||||
```
|
||||
such that it is ensured that synapse is running before the bridge tries to connect.
|
||||
(If it worked after installation but broke after a restart this probably is it.)
|
||||
|
||||
## Documentations et ressources
|
||||
|
||||
* 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 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
|
||||
* Documentation YunoHost pour cette app : https://yunohost.org/app_mautrix_telegram
|
||||
* Signaler un bug : https://github.com/YunoHost-Apps/mautrix_telegram_ynh/issues
|
||||
|
||||
## Informations pour les développeurs
|
||||
|
||||
**Seulement si vous voulez utiliser une branche de test pour le codage, au lieu de fusionner directement dans la banche principale.**
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing).
|
||||
Merci de faire vos pull request sur la [branche testing](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing).
|
||||
|
||||
Pour essayer la branche testing, procédez comme suit.
|
||||
```
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_ynh/tree/testing --debug
|
||||
sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug
|
||||
ou
|
||||
sudo yunohost app upgrade REPLACEBYYOURAPP -u https://github.com/YunoHost-Apps/REPLACEBYYOURAPP_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
|
33
doc/DESCRIPTION.md
Normal file
33
doc/DESCRIPTION.md
Normal file
|
@ -0,0 +1,33 @@
|
|||
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.
|
||||
|
||||
## List of known public services
|
||||
* Ask on one of the following rooms: #mautrix_yunohost:matrix.fdn.fr or #telegram:maunium.net
|
||||
|
||||
## Bridging usage
|
||||
** Note that several Telegram and Matrix users can be bridged, each Telegram account has its own bot administration room. If they are in a same Telegram group, only one matrix room will be created. **
|
||||
|
||||
### Bridge a Telegram user and a Matrix user
|
||||
* First your Matrix user or Synapse Server has to be authorized in the Configuration of the bridge (see below)
|
||||
* Then, invite the bot (default @telegrambot:yoursynapse.domain) in this new Mautrix-Telegram bot administration room.
|
||||
* If the Bot does bot accept, see the [troubleshooting page](https://docs.mau.fi/bridges/general/troubleshooting.html)
|
||||
* Send ``!tg help`` to the bot in the created room to know how to control the bot.
|
||||
See also [upstream wiki Authentication page](https://docs.mau.fi/bridges/python/telegram/authentication.html)
|
||||
|
||||
#### Logging into Telegram account
|
||||
* Type ``login`` or ``login-qr`` (untested) in main management room (`!tg` in any bridge room)
|
||||
* follow setup instructions from bot
|
||||
* By defaults, only conversations with very recent messages and groups will be suggested to be bridged
|
||||
* Accept invitations to the bridged chat rooms
|
||||
|
||||
#### Registering the Bridge as a primary device (untested)
|
||||
* Type ``!tg register <phone>``, where ``<phone>`` is your phone number in the internation format with no space, e.g. ``!tg register +33612345678``
|
||||
* Answer in the bot room with the verification code that you reveived in SMS.
|
||||
* Set a profile name with ``!tg set-profile-name <name>``
|
||||
|
||||
### Double puppeting
|
||||
* Log in with ``login-matrix <access token>``
|
||||
* After logging in, the default Matrix puppet of your Telegram account should leave rooms and your account should join all rooms the puppet was in automatically.
|
||||
|
||||
|
||||
### Relaybot: Bridge a group for several Matrix and several Telegram users to chat together
|
||||
* see https://docs.mau.fi/bridges/python/telegram/relay-bot.html
|
46
doc/DISCLAIMER.md
Normal file
46
doc/DISCLAIMER.md
Normal file
|
@ -0,0 +1,46 @@
|
|||
### Configuration of the bridge
|
||||
|
||||
The bridge is [roughly configured at installation](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/blob/master/conf/config.yaml), e.g. allowed admin and user of the bot. Finer configuration can be done by modifying the
|
||||
following configuration file with SSH:
|
||||
```/opt/yunohost/mautrix_telegram/config.yaml```
|
||||
and then restarting the mautrix_telegram service.
|
||||
|
||||
### Documentation
|
||||
|
||||
* Official "Mautrix-Telegram" documentation: https://docs.mau.fi/bridges/python/telegram/index.html
|
||||
* Matrix room (Matrix Bridges in Yunohost): #mautrix_yunohost:matrix.fdn.fr
|
||||
* Matrix room (upstream app): #telegram:maunium.net
|
||||
In case you need to upload your logs somewhere, be aware that they contain your contacts' and your phone numbers. Strip them out with
|
||||
``| sed -r 's/[0-9]{10,}/📞/g' ``
|
||||
* "Mautrix-Telegram" bridge is based on the [telegram daemon](https://gitlab.com/telegramd/telegramd) project.
|
||||
* YunoHost documentation: If more specific documentation is needed, feel free to contribute.
|
||||
|
||||
#### Multi-user support
|
||||
|
||||
* Bot users are not related to Yunohost users. Any Matrix account or Synapse server autorized in the configuration of the bridge can invite/use the bot.
|
||||
* The Telegram bot is a local Matrix-Synapse user, but accessible through federation (synapse public or private).
|
||||
* Several Telegram and Matrix users can be bridged with one bridge, each user has its own bot administration room.
|
||||
* If several bot users are in a same Telegram group, only one Matrix room will be created by the bridge.
|
||||
* See https://github.com/YunoHost-Apps/synapse_ynh#multi-users-support
|
||||
|
||||
#### Multi-instance support
|
||||
|
||||
* Multi-instance installation should work. Several bridge instances could be installed for one Matrix-Synapse instance so that one Matrix user can bridge several Telegram accounts.
|
||||
* Several bridge instances could be installed for each Matrix-Synapse instance to benefit from it. But one bridge can be used by users from several Matrix-Synapse instances.
|
||||
|
||||
#### Supported architectures
|
||||
|
||||
* x86-64 - [![Build Status](https://ci-apps.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps.yunohost.org/ci/apps/mautrix_telegram/)
|
||||
* ARMv8-A - [![Build Status](https://ci-apps-arm.yunohost.org/ci/logs/mautrix_telegram%20%28Apps%29.svg)](https://ci-apps-arm.yunohost.org/ci/apps/mautrix_telegram/)
|
||||
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
* Check the spelling of the bot name!
|
||||
* For slow servers it might be necessary to run ``systemctl edit mautrix_telegram.service`` (also for `coturn.service` and `coturn-synapse.service`) and insert
|
||||
```
|
||||
[Service]
|
||||
ExecStartPre=/bin/sleep 90
|
||||
```
|
||||
such that it is ensured that synapse is running before the bridge tries to connect.
|
||||
(If it worked after installation but broke after a restart this probably is it.)
|
|
@ -8,7 +8,7 @@ about: When creating a bug report, please use the following template to provide
|
|||
1. *Read this whole template first.*
|
||||
2. *Determine if you are on the right place:*
|
||||
- *If you were performing an action on the app from the webadmin or the CLI (install, update, backup, restore, change_url...), you are on the right place!*
|
||||
- *Otherwise, the issue may be due to REPLACEBYYOURAPP itself. Refer to its documentation or repository for help.*
|
||||
- *Otherwise, the issue may be due to mautrix_telegram itself. Refer to its documentation or repository for help.*
|
||||
- *When in doubt, post here and we will figure it out together.*
|
||||
3. *Delete the italic comments as you write over them below, and remove this guide.*
|
||||
---
|
||||
|
@ -31,7 +31,7 @@ about: When creating a bug report, please use the following template to provide
|
|||
|
||||
- *If you performed a command from the CLI, the command itself is enough. For example:*
|
||||
```sh
|
||||
sudo yunohost app install REPLACEBYYOURAPP
|
||||
sudo yunohost app install mautrix_telegram
|
||||
```
|
||||
- *If you used the webadmin, please perform the equivalent command from the CLI first.*
|
||||
- *If the error occurs in your browser, explain what you did:*
|
||||
|
|
|
@ -7,7 +7,14 @@
|
|||
"fr": "Passerelle Telegram pour Matrix/Synapse"
|
||||
},
|
||||
"version": "0.10.1~ynh3",
|
||||
"url": "https://github.com/mautrix/telegram",
|
||||
"url": "https://docs.mau.fi/bridges/python/telegram/index.html",
|
||||
"upstream": {
|
||||
"license": "free",
|
||||
"website": "https://docs.mau.fi/bridges/python/telegram/index.html",
|
||||
"admindoc": "https://github.com/YunoHost-Apps/mautrix_telegram_ynh",
|
||||
"userdoc": "https://docs.mau.fi/bridges/python/telegram/management-commands.html",
|
||||
"code": "https://github.com/mautrix/telegram"
|
||||
},
|
||||
"license": "AGPL-3.0-or-later",
|
||||
"maintainer": {
|
||||
"name": "Benedikt Tissot",
|
||||
|
|
|
@ -15,4 +15,4 @@
|
|||
---
|
||||
*If you have access to [App Continuous Integration for packagers](https://yunohost.org/#/packaging_apps_ci) you can provide a link to the package_check results like below, replacing '-NUM-' in this link by the PR number and USERNAME by your username on the ci-apps-dev. Or you provide a screenshot or a pastebin of the results*
|
||||
|
||||
[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/REPLACEBYYOURAPP_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/REPLACEBYYOURAPP_ynh%20PR-NUM-%20(USERNAME)/)
|
||||
[![Build Status](https://ci-apps-dev.yunohost.org/jenkins/job/mautrix_telegram_ynh%20PR-NUM-%20(USERNAME)/badge/icon)](https://ci-apps-dev.yunohost.org/jenkins/job/mautrix_telegram_ynh%20PR-NUM-%20(USERNAME)/)
|
||||
|
|
Loading…
Reference in a new issue