Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/autogestion/pubgate-telegram
Extension for PubGate, Telegram <-> ActivityPub bridge
https://github.com/autogestion/pubgate-telegram
activitypub pubgate sanic telegram telethon
Last synced: 24 days ago
JSON representation
Extension for PubGate, Telegram <-> ActivityPub bridge
- Host: GitHub
- URL: https://github.com/autogestion/pubgate-telegram
- Owner: autogestion
- License: bsd-3-clause
- Created: 2019-03-22T22:43:05.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-12-06T16:03:50.000Z (almost 3 years ago)
- Last Synced: 2024-04-13T21:04:14.175Z (7 months ago)
- Topics: activitypub, pubgate, sanic, telegram, telethon
- Language: Python
- Homepage:
- Size: 20.5 KB
- Stars: 18
- Watchers: 4
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## PubGate Telegram <-> ActivityPub bridge
Extension for [PubGate](https://github.com/autogestion/pubgate), federates Telegram channels and back
Requires PubGate >= 0.2.19
## Deploy
Create Telegram bot and invite it to channels going to be bridged with admin permissions
###### Install Docker + Docker Compose
#### Shell
```
git clone https://github.com/autogestion/pubgate.git
cp -r config/extensions_sample_conf.cfg config/conf.cfg
```
##### Edit config/conf.cfg to change setup of your instance, next values should be added
```
EXTENSIONS = [..., "pg_telegram"]
# These example values won't work. You must get your own api_id and
# api_hash from https://my.telegram.org, under API Development.
TELEGRAM_API_ID = 12345
TELEGRAM_API_HASH = '0123456789abcdef0123456789abcdef'
TELEGRAM_BOT_TOKEN = "get from https://core.telegram.org/bots#6-botfather"
CHECK_BOXES_TIMEOUT = 3
```
This will connect Telegram bot to PubGate server. To connect it to Fediverse, setup PubGate AP account.
Account could be created on deploy by adding next value to config/conf.cfg or later via API (described below)
```
USER_ON_DEPLOY = """{
"username": "user",
"password": "pass",
"profile": {
"type": "Service",
"name": "TelePub",
"summary": "Broadcast from Telegram channel",
"icon": {
"type": "Image",
"mediaType": "image/png",
"url": "https://cdn1.iconfinder.com/data/icons/blockchain-8/48/icon0008_decentralize-512.png"
}
},
"details": {
"tgbot": {
"channels": [""],
"enable": true,
"tags": ["telegram", "bridge"]
}
}
}"""
```
More on user configuration
- profile - contains information which will represent bridge in Fediverse
- details.tgbot.channels - should be updated with targeted Telegram channel(s)
- details.tgbot.tags - tags which will be auto-added to every post, could be []
##### Edit requirements/extensions.txt by adding next row
```
git+https://github.com/autogestion/pubgate-telegram.git
```
Then, instance could be started
```
domain=put-your-domain-here.com docker-compose up -d
```
### Usage
- To get updates from Telegram channels (where Telegram bot was added) just follow PubGate account from any other AP account
- To send updates to Telegram, make PubGate account follow targeted accounts (regular AP Follow, via UI or API, endpoint and payload are described in postman collection in [Pubgate repo](https://github.com/autogestion/pubgate/blob/master/pubgate.postman_collection.json)
#### Bots Creation via API
```
/user POST
```
payload
```
Same as used for USER_ON_DEPLOY value, triple quotes should be stripped
```
If register by invite enabled, "invite": "" should be added to payload
##### Restart app after adding new bot or updating old one
#### Disable/Update bot
```
/ PATCH (auth required)
```
payload
```
{
"details": {
"tgbot": {
"channels": ["telapub"], #change to update channel's list
"enable": false, #"enable": true to re-enable
"tags": ["telegram", "bridge"]
}
}
}
```