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
mautrix_telegram_ynh/README.md

45 lines
2.6 KiB
Markdown
Raw Normal View History

Auto-update README
2023-12-12 12:21:26 +01:00
<!--
Auto-update READMEs
2024-03-26 16:24:24 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
Auto-update README
2023-12-12 12:21:26 +01:00
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) ![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)
Auto-update READMEs
2024-04-16 16:54:32 +02:00
*[Read this README in other languages.](./ALL_README.md)*
Auto-update README
2023-12-12 12:21:26 +01:00
Auto-update READMEs
2024-03-26 16:24:24 +01:00
> *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.*
Auto-update README
2023-12-12 12:21:26 +01:00
## 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.
Bump version
2024-02-28 20:23:19 +01:00
**Shipped version:** 0.15.1~ynh2
make linter even more happy
2021-09-13 20:26:32 +02:00
## Documentation and resources
copy from mautrix_signal_ynh first version install Add plain configuration file from mautrix-facebook repository Start converting mautrix-facebook config file as yunohost config template adapt install and config files add manifest and encryption option typo typo typo add postgresql dependency move config in conf folder try setup sources correctly tar.gz correct pip3 and python3 typo correct python env correct python env install wheel full path to app Update install Update install Update install Update install Update install Update install add remove script create community for bridged chats adapt mautrix_facebook to mautrix_signal setup sources add signald extra dependency add key extra repo python dep python optional requirements optional requirements again all requirements argh wrong wheel missing dependencies extra dep stickers not building README en finalize README
2021-03-24 22:49:07 +01:00
Auto-update READMEs
2024-03-26 16:24:24 +01:00
- 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>
copy from mautrix_signal_ynh first version install Add plain configuration file from mautrix-facebook repository Start converting mautrix-facebook config file as yunohost config template adapt install and config files add manifest and encryption option typo typo typo add postgresql dependency move config in conf folder try setup sources correctly tar.gz correct pip3 and python3 typo correct python env correct python env install wheel full path to app Update install Update install Update install Update install Update install Update install add remove script create community for bridged chats adapt mautrix_facebook to mautrix_signal setup sources add signald extra dependency add key extra repo python dep python optional requirements optional requirements again all requirements argh wrong wheel missing dependencies extra dep stickers not building README en finalize README
2021-03-24 22:49:07 +01:00
## Developer info
Auto-update READMEs
2024-03-26 16:24:24 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing).
copy from mautrix_signal_ynh first version install Add plain configuration file from mautrix-facebook repository Start converting mautrix-facebook config file as yunohost config template adapt install and config files add manifest and encryption option typo typo typo add postgresql dependency move config in conf folder try setup sources correctly tar.gz correct pip3 and python3 typo correct python env correct python env install wheel full path to app Update install Update install Update install Update install Update install Update install add remove script create community for bridged chats adapt mautrix_facebook to mautrix_signal setup sources add signald extra dependency add key extra repo python dep python optional requirements optional requirements again all requirements argh wrong wheel missing dependencies extra dep stickers not building README en finalize README
2021-03-24 22:49:07 +01:00
Auto-update READMEs
2024-03-26 16:24:24 +01:00
To try the `testing` branch, please proceed like that:
Auto-update README
2022-05-29 17:44:59 +02:00
Auto-update READMEs
2024-03-26 16:24:24 +01:00
```bash
change signal to telegram add commas to make json happy some minor enhancements hopefully fix mising bdist_wheel add zlib1g-dev as dependency needed to compile / install pillow in virtualenv libjpeg is also a dep of pillow disable packages requiring pillow for now another try with corrected config.toml add missing arguments to alembic try other options for alembic try again with the binary... final try for the alembic configuration enable failure cleaning again alembic still fails... try to fix alembic step we do not need to activate the venv in this case finally working installation use the default database options make upgrade possible bump version, to upgrade... better upgrade script remove unnecessary upgrade bits hopefully we converge remove more unused stuff upgrading should save the auto generated values... fix a type and upgrade script disable abort if errors reenable abort if errors puppeting is actually the usefull permission troubleshooting page further improve readme
2021-02-22 13:21:58 +01:00
sudo yunohost app install https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug
copy from mautrix_signal_ynh first version install Add plain configuration file from mautrix-facebook repository Start converting mautrix-facebook config file as yunohost config template adapt install and config files add manifest and encryption option typo typo typo add postgresql dependency move config in conf folder try setup sources correctly tar.gz correct pip3 and python3 typo correct python env correct python env install wheel full path to app Update install Update install Update install Update install Update install Update install add remove script create community for bridged chats adapt mautrix_facebook to mautrix_signal setup sources add signald extra dependency add key extra repo python dep python optional requirements optional requirements again all requirements argh wrong wheel missing dependencies extra dep stickers not building README en finalize README
2021-03-24 22:49:07 +01:00
or
change signal to telegram add commas to make json happy some minor enhancements hopefully fix mising bdist_wheel add zlib1g-dev as dependency needed to compile / install pillow in virtualenv libjpeg is also a dep of pillow disable packages requiring pillow for now another try with corrected config.toml add missing arguments to alembic try other options for alembic try again with the binary... final try for the alembic configuration enable failure cleaning again alembic still fails... try to fix alembic step we do not need to activate the venv in this case finally working installation use the default database options make upgrade possible bump version, to upgrade... better upgrade script remove unnecessary upgrade bits hopefully we converge remove more unused stuff upgrading should save the auto generated values... fix a type and upgrade script disable abort if errors reenable abort if errors puppeting is actually the usefull permission troubleshooting page further improve readme
2021-02-22 13:21:58 +01:00
sudo yunohost app upgrade mautrix_telegram -u https://github.com/YunoHost-Apps/mautrix_telegram_ynh/tree/testing --debug
copy from mautrix_signal_ynh first version install Add plain configuration file from mautrix-facebook repository Start converting mautrix-facebook config file as yunohost config template adapt install and config files add manifest and encryption option typo typo typo add postgresql dependency move config in conf folder try setup sources correctly tar.gz correct pip3 and python3 typo correct python env correct python env install wheel full path to app Update install Update install Update install Update install Update install Update install add remove script create community for bridged chats adapt mautrix_facebook to mautrix_signal setup sources add signald extra dependency add key extra repo python dep python optional requirements optional requirements again all requirements argh wrong wheel missing dependencies extra dep stickers not building README en finalize README
2021-03-24 22:49:07 +01:00
```
Auto-update READMEs
2024-03-26 16:24:24 +01:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>
Reference in a new issue Copy permalink