https://github.com/trustmaster/telerss

Telegram RSS feed aggregator bot
https://github.com/trustmaster/telerss

Last synced: 23 days ago
JSON representation

Telegram RSS feed aggregator bot

• Host: GitHub
• URL: https://github.com/trustmaster/telerss
• Owner: trustmaster
• License: apache-2.0
• Created: 2023-10-10T19:07:28.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-15T12:13:58.000Z (about 1 year ago)
• Last Synced: 2024-10-15T21:29:43.730Z (2 months ago)
• Language: TypeScript
• Size: 421 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: Readme.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TeleRSS - Telegram RSS Feed Aggregator Bot

TeleRSS bot is the most convenient way of subscribing to RSS feeds and receiving updates from them in Telegram.

![Screenshot](./screenshot.jpg)

## Features

- Runs in [CloudFlare Workers](https://workers.cloudflare.com/), you can create your own private bot instance for free

- Supports multiple users

- Use Telegram chats as feeds, subscribing multiple RSS feeds to a single chat

## Supported commands

- `/start` - start the bot

- `/help` - show help

- `/list` - list all feeds

- `/sub ` - subscribe to a new RSS feed

- `/unsub ` - unsubscribe from an RSS feed

- `/unsub_all` - unsubscribe from all RSS feeds

## Using a public bot instance

_**Privacy and security** warning: the bot instance will have access to the chat where you add it. Your subscriptions will be stored in a Key-value store shared with other users. If the public bot instance is compromised, your subscriptions may be leaked or lost. If you need more privacy and security, install your own bot instance instead._

1. Add [@TeleRSS notify bot](https://t.me/TeleRSSnotify_bot) to your Telegram chat

2. Send `/start` command to the bot

3. Send `/help` to see he list of available commands

## Deploying your own bot instance to CloudFlare Workers

### CloudFlare Worker deployment

1. Create a new CloudFlare account if you don't have one yet.

2. Log into [CloudFlare dashboard](https://dash.cloudflare.com).

3. Follow the [Get started guide](https://developers.cloudflare.com/workers/get-started/guide/) to get started with the app via Wrangler.

4. Clone this repository into your CloudFlare worker app.

5. Copy `wrangler.example.toml` to `wrangler.toml` and fill in the values.

6. Deploy the bot: `npm run deploy`

### Setting up a new Telegram bot

1. Create a new Telegram bot using [@BotFather](https://t.me/BotFather).

2. Copy the bot token and paste it into a `TELEGRAM_TOKEN` environment variable, which you can set in the CloudFlare dashboard -> Workers & Pages ->  -> Settings -> Variables.

3. Generate a secret token of 8-256 characters (only alphanumeric dash and underscore are allowed), e.g. `kasD2198casdS12kd`, and paste it into a `SECRET_TOKEN` environment variable similar to previous step.

4. Register the Telegram Webhook by editing a special URL `https://api.telegram.org/bot/setWebhook?url=&secret_token=` and opening it in the browser.