This repository has been archived on 2023-01-19. You can view files and clone it, but cannot push or open issues or pull requests.
MirrorTea/README.md
2023-01-11 23:19:01 +03:00

64 lines
1.5 KiB
Markdown

MirrorTea 🐦
=========
**New lite [Matrix](https://matrix.org) <-> [Telegram](https://telegram.org) bridge for personal use, replacement of
[mautrix-telegram](https://github.com/mautrix/telegram)**.
For the matrix server is represented by a single and regular user. To simulate chats with different users, creates rooms in matrix, and sets /roomnick and /roomavatar corresponding to the simulated user in telegram.
For telegram, it can be represented as a single bot.
#### Advantages over the current [mautrix-bridge](https://github.com/mautrix/telegram):
- Supports the bot's private message bridge
- Requires no permanent host (server)
- Can run from a phone (termux) or user computer
- Does not require a domain
- Doesn't require a static IP
- No synapse server required
- Easy to deploy, unlike synapse
- Doesn't require any computing power like synapse
- Not tied to a specific matrix server
#### Disadvantages:
- Doesn't support papits
- No support for groups
## Install 🌺
#### Clone repository
```git clone https://inex.dev/def/MirrorTea && cd MirrorTea```
#### Then edit ```.env``` secrets config
```mv .env.example .env```
```nano .env```
Make sure the .env file have permissions 600 (read\write only for owner)
```chmod 600 .env```
#### Edit ```config.yaml```
```nano config.yaml```
Do not change options with brackets ```"{{ }}"```, these are templates.
#### Run on *unix-like systems:
```pip install -r requirements.txt```
```python3 mirrortea```
#### Run with docker:
```docker-compose up --build```
kotov isprav eto