GithubHelp home page GithubHelp logo

seth-rah / telegram-rss-return Goto Github PK

View Code? Open in Web Editor NEW
0.0 2.0 0.0 26 KB

Return RSS values based on given criteria

License: GNU General Public License v3.0

Dockerfile 3.64% JavaScript 96.36%

telegram-rss-return's Introduction

telegram-rss-return

Return RSS values based on given criteria specified in a text file, and the docker environment variables

What is this?

This is a hobby project to monitor updates on RSS feeds to send updates to Telegram messenger.

How to Run

Multiple -e entries for various environments. environment variables listed further down.

docker run -d -e TELEGRAM_BOT_TOKEN=secret1 -e TELEGRAM_CHAT_ID=secret2 -e RSS_URL=https://RSS_URL_HERE -e COMPARATOR=ValueYouAreComparing -e YIELD=ValueYouAreReturningIfComparisonPasses -e OPTION=AdditionalValueToCompareAgainstCOMPARATOR -v Bases.txt:/usr/src/parser/Bases.txt sethrah/telegramrssreturn

Docker Compose

For fast setup, download the docker-compose.yml file and use docker-compose to manage the container a bit easier.

curl -o https://raw.githubusercontent.com/seth-rah/FFXIV_Telegram_News/master/docker-compose.yml

Relpace environment variables as needed and run docker-compose up -d once completed.

Environment Variables

Telegram

Set up a telegram bot and get the Bot Token. Then add the bot to a group, make it admin and extract the Chat ID.

Telegram Bot Token                            		=	TELEGRAM_BOT_TOKEN
Telegram Chat ID                              		=	TELEGRAM_CHAT_ID

RSS

URL that you are monitoring for RSS updates		=	RSS_URL
Value you are comparing to Bases.txt          		=	COMPARATOR
Value you want to return if comparator passes    	=	YIELD
Additional value you want to pass with Bases.txt 	=	OPTION

Volumes

RSS

2 Files are made use of with this application. Bases.txt and cache.txt. You need to mount in Bases yourself in order to provide the application with the rules for the comparator. If text on a line passes the comparator check, then you will get a post created on Telegram.

The file you don't need to worry about is cache.txt. This file will keep track of the information that has already been posted to telegram, and will clean itself up with time automatically to avoid cluttering your system.

Plans

None at this time.

Contribution

Please let me know through an issue or pull request.

telegram-rss-return's People

Contributors

seth-rah avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.