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

64 lines
1.5 KiB
Markdown
Raw Permalink Normal View History

2023-01-10 11:26:56 +00:00
MirrorTea 🐦
2022-10-17 09:31:01 +00:00
=========
2023-01-11 20:17:34 +00:00
**New lite [Matrix](https://matrix.org) <-> [Telegram](https://telegram.org) bridge for personal use, replacement of
2023-01-11 20:19:01 +00:00
[mautrix-telegram](https://github.com/mautrix/telegram)**.
2023-01-10 11:17:12 +00:00
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.
2023-01-11 20:19:01 +00:00
#### Advantages over the current [mautrix-bridge](https://github.com/mautrix/telegram):
2023-01-10 11:17:12 +00:00
- 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
2023-01-11 20:17:34 +00:00
- Doesn't require a static IP
2023-01-10 11:17:12 +00:00
- No synapse server required
- Easy to deploy, unlike synapse
- Doesn't require any computing power like synapse
- Not tied to a specific matrix server
2023-01-10 11:26:56 +00:00
#### Disadvantages:
2023-01-10 11:17:12 +00:00
2023-01-10 11:26:56 +00:00
- Doesn't support papits
- No support for groups
2023-01-10 11:17:12 +00:00
2023-01-10 11:26:56 +00:00
## Install 🌺
2023-01-10 11:17:12 +00:00
#### Clone repository
```git clone https://inex.dev/def/MirrorTea && cd MirrorTea```
2023-01-10 11:26:56 +00:00
#### Then edit ```.env``` secrets config
2023-01-10 11:17:12 +00:00
```mv .env.example .env```
```nano .env```
2023-01-10 18:46:31 +00:00
Make sure the .env file have permissions 600 (read\write only for owner)
```chmod 600 .env```
2023-01-10 13:49:30 +00:00
#### Edit ```config.yaml```
```nano config.yaml```
Do not change options with brackets ```"{{ }}"```, these are templates.
2023-01-10 11:17:12 +00:00
#### Run on *unix-like systems:
```pip install -r requirements.txt```
```python3 mirrortea```
#### Run with docker:
```docker-compose up --build```
kotov isprav eto