mirror of
https://github.com/YunoHost-Apps/mautrix_telegram_ynh.git
synced 2024-09-03 19:45:55 +02:00
46 lines
2.7 KiB
Markdown
46 lines
2.7 KiB
Markdown
### 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 - [](https://ci-apps.yunohost.org/ci/apps/mautrix_telegram/)
|
|
* ARMv8-A - [](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.)
|