https://github.com/rasjonell/telegram-to-rss
Telegram Bot to generate an RSS feed from group messages
https://github.com/rasjonell/telegram-to-rss
rss rss-feed telegram telegram-bot
Last synced: 8 months ago
JSON representation
Telegram Bot to generate an RSS feed from group messages
- Host: GitHub
- URL: https://github.com/rasjonell/telegram-to-rss
- Owner: rasjonell
- Created: 2022-11-20T10:48:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-04-01T09:23:35.000Z (about 2 years ago)
- Last Synced: 2024-04-01T10:33:15.376Z (about 2 years ago)
- Topics: rss, rss-feed, telegram, telegram-bot
- Language: TypeScript
- Homepage: https://rasjonell.github.io/telegram-to-rss
- Size: 729 KB
- Stars: 17
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Telegram To RSS
Generate an RSS feed from your Telegram Channel.
# Why did I make this?
I run a personal website and want it to be a centralized place where I can have everything I ever published on the web. I also don't want to have a telegram integration on that website and prefer having a unified way of accessing my web artifacts.
With this project I can turn my Telegram channel posts into an RSS feed and parse it on my personal website.
# How does it work?
This Project is consisted of two distinct services:
- Telegram Bot Handler
- Express File Server
## Telegram Bot Handler
This service listens to messages on the [discussion group chat](https://core.telegram.org/api/discussion) of your channel.
When you post a message on your channel, Telegram will automatically forward the message to the corresponding discussion group, then the bot will process the message and update the RSS feed accordingly.
## Express File Server
When the Bot Handler receives the message and updates the RSS Feed, it writes an `rss.xml` file in the `public/` directory which is served by the express static file server.
Thus you can access the RSS feed via: `/rss.xml`.
# Getting Started
In order to use this project, you need:
- Telegram Bot
- Create one with [`BotFather`](https://www.teleme.io/articles/create_your_own_telegram_bot?hl=en)
- Disable group privacy mode
- Copy the API KEY
- Telegram Channel
- After creating the channel, create a discussion group.
- Add the newly created bot account to the discussion group.
Afterwards, clone the project and install the dependencies:
```sh
git clone https://github.com/rasjonell/telegram-to-rss
```
```sh
cd telegram-to-rss
```
```sh
npm install
```
## Configuration
Follow the `.env.example` file to setup your environment.
_Note: You need to create separate `.env.{NODE_ENV}` files for each environment(i.e. `.env.dev` will be used when testing locally)_
|Name|Type|Description|
|---|---|---|
|PORT|Number|File Server Port|
|GROUP_ID|String|Your Channel ID|
|BOT_TOKEN|String|Your Bot's API key|
|GROUP_USERNAME|String|Your Channel Username|
|AUTHOR|String|RSS Feed Author Name|
|WEBSITE_HOST|String|URL Of The RSS Feed Host Website|
## Available Scripts
- `npm start` - starts the project.
- `npm run watch` - starts `nodemon` development server.
- `npm run build` - builds the TypeScript project.
## TODOs
- [x] Make RSS feed metadata configurable
- [ ] Persist the auto-generated RSS Feed so stopping/restarting the process does not override it.
- [ ] Make Feed generation configurable(Currently only the messages from the Channel admin are allowed, but some may want to also include discussion messages from other members(i.e. replies)).