RSS-To-Telegram

RSS-To-Telegram

Docker app from BoKKeR's Repository

Overview

A self-hosted telegram JS/TS bot that dumps posts from RSS feeds to a telegram chat. This script was created because all the third party services were unreliable, slow.

RSSTT

GitHub tag (latest by date) Docker Pulls Docker Stars GitHub Workflow Status (branch) Docker Image Size (latest by date)

RSS to Telegram bot

A self-hosted telegram JavaScript/TypeScript bot that dumps posts from RSS feeds to a telegram chat. This script was created because all the third party services were unreliable.

The bot is publicly available on telegram: http://t.me/rss_t_bot

help

Docker

For the docker image go to: https://hub.docker.com/r/bokker/rss.to.telegram/

Installation

Dont forget to use the right node version. nvm use or match the version in .nvmrc

npm install
cp .env.example .env
npm run dev

Dont forget to fill the .env file

A telegram bot is needed that the script will connect to. https://botsfortelegram.com/project/the-bot-father/ Running the script and typing in /help will reveal all the commands

  1. Clone the script
  2. Save and run
  3. Use the telegram commands to manage feeds

Known issues

There are no known issues but the telegram API has limitations on how many messages per chat you can receive

Docker

This container uses Redis and Bull for queuing the messages

docker create \
  --name=rss.to.telegram \
  -e TOKEN=chat:token \
  -e DEBUG=false \
  -e REDIS_HOST=127.0.0.1 \
  -e REDIS_PORT=6379 \
  -e REDIS_USER=default \
  -e REDIS_PASSWORD=secret \
  -e REDIS_MUTEX=random-value \
  -v /path/to/host/config:/app/config \
  --restart unless-stopped \
  bokker/rss.to.telegram

Prisma

Prisma is used to manage SQLite structure changes and as a ORM

To create any change you need to do the following:

  1. Backup current database
  2. Alter the prisma.schema
  3. npx prisma migrate dev -n migration-name
  4. test the migration on an old version of the database npx prisma migrate deploy
  5. test the migration by having no database npx prisma migrate deploy

Install RSS-To-Telegram on Unraid in a few clicks.

Find RSS-To-Telegram in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for RSS-To-Telegram Review the template variables and paths Click Install

Download Statistics

171,019
Total Downloads
61
This Month
88
Avg / Month

Total Downloads Over Time

Loading chart...

Related apps

Details

Repository
bokker/rss.to.telegram:latest
Last Updated2024-06-17
First Seen2020-08-15

Runtime arguments

Network
bridge
Shell
sh
Privileged
false

Template configuration

TOKENVariable

Telegram bot token https://botsfortelegram.com/project/the-bot-father/

Config PathPathrw

Config Path

Target
/config
Default
/mnt/user/appdata/rsstt
Value
/mnt/user/appdata/rsstt
DEBUGVariable

Enable debug mode for more logs

Default
false
REDIS_HOSTVariable

Redis host ip

Default
127.0.0.1
REDIS_PORTVariable

Redis host port

Default
6379
REDIS_USERVariable

Redis user

Default
default
REDIS_PASSWORDVariable

Redis password

Default
secret
REDIS_MUTEXVariable

Redis mutex, used in case of running multiple instances

Default
randomvalue