Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xtrime-ru/telegramrss
Convert telegram posts to RSS or json in amphp server
https://github.com/xtrime-ru/telegramrss
amphp async json microservice php rss self-hosted server telegram
Last synced: 7 days ago
JSON representation
Convert telegram posts to RSS or json in amphp server
- Host: GitHub
- URL: https://github.com/xtrime-ru/telegramrss
- Owner: xtrime-ru
- License: mit
- Created: 2019-02-04T19:56:52.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-03T15:32:25.000Z (about 1 month ago)
- Last Synced: 2024-10-16T11:59:40.715Z (20 days ago)
- Topics: amphp, async, json, microservice, php, rss, self-hosted, server, telegram
- Language: PHP
- Homepage: https://tg.i-c-a.su
- Size: 220 KB
- Stars: 236
- Watchers: 9
- Forks: 42
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TelegramRSS
RSS/JSON generator for telegram
Get posts from my [TelegramApiServer](https://github.com/xtrime-ru/TelegramApiServer) and output them as RSS or JSON.
## Features
* Fast async [amphp](https://github.com/amphp/) http server
* Use as micro-service to access Telegram API
* Get any public telegram posts from groups as json or RSS
* fail2ban, RPM limits, IP blacklist
* Full media support. Access any media from messages via direct links.
## Architecture Example
## Installation
1. Install docker
```shell
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh ./get-docker.sh
```
1. Install and start [Telegram Api Server](https://github.com/xtrime-ru/TelegramApiServer)
1. Install and start
```shell
git clone https://github.com/xtrime-ru/TelegramRSS.git TelegramRSS
cd TelegramRSS
```
1. `cp .env.docker.example .env.docker` and check settings in .env.docker: domain, ratelimit, allowed refferes, etc...
1. Start container:
```
docker compose pull
docker compose up -d
```
## Upgrade to v4
```shell
git pull
docker compose pull
cp .env.docker .env.docker.v1
cat .env.docker.example > .env.docker
#check new config and move old options from your .env.docker.v1 to new .env.docker
docker compose up -d
```
## Additional steps
1. Edit `.env.docker` if needed.
1. Restart RSS server `docker compose restart`
1. Example of Nginx config
```
server {
listen %ip%:443 ssl;
server_name tg.i-c-a.su;
ssl_certificate /home/admin/conf/web/ssl.tg.i-c-a.su.pem;
ssl_certificate_key /home/admin/conf/web/ssl.tg.i-c-a.su.key;
location / {
proxy_set_header Host $http_host;
proxy_set_header SERVER_PORT $server_port;
proxy_set_header REMOTE_ADDR $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header Upgrade $http_upgrade;
fastcgi_param REMOTE_ADDR $http_x_real_ip;
proxy_http_version 1.1;
proxy_set_header Connection "keep-alive";
proxy_pass http://127.0.0.1:9504;
}
}
```
Set `REAL_IP_HEADER=X-Forwarded-For` in .env.docker to retrieve client IP from nginx.
## Examples
### JSON
* URL: https://tg.i-c-a.su/json/breakingmash
* Custom limit: https://tg.i-c-a.su/json/breakingmash?limit=50
Maximum: 100 posts
* Pagination: https://tg.i-c-a.su/json/breakingmash?page=2
* Get one message: https://tg.i-c-a.su/json/breakingmash?id=10738&limit=1
### RSS
* URL: https://tg.i-c-a.su/rss/breakingmash
* Custom limit: https://tg.i-c-a.su/rss/breakingmash?limit=50
Maximum: 100 posts
* Pagination: https://tg.i-c-a.su/rss/breakingmash/2
* Get one message: https://tg.i-c-a.su/rss/breakingmash?id=10738&limit=1
### Media
* https://tg.i-c-a.su/media/breakingmash/10738/preview
* https://tg.i-c-a.su/media/breakingmash/10738
Default address of RSS server is `http://127.0.0.1:9504/`
## Contacts
* Telegram: [@xtrime](tg://resolve?domain=xtrime)
* Email: alexander(at)i-c-a.su