Giter Club home page Giter Club logo

feederbot's Introduction

Feederbot

An Atom, RSS, and JSON feed reading Telegram bot ๐Ÿค–

Feederbot checks on a user configurable interval for feed updates.

Prerequisites

  1. A Telegram bot token from @BotFather

  2. Your Telegram user ID from @userinfobot

  3. Docker

Supported Commands

  • /addfeeds <url> ... - Add feeds.

  • /removefeeds <url> ... - Remove feeds.

  • /start <interval> - Start reading feeds.

  • /changeinterval <interval> - Change the feed update interval.

  • /showfeeds - Show feeds.

  • /showjob - Show the datetime of the next feed update job.

Setup

  1. Build the container image:

    # Using docker-compose
    docker-compose build
    # Using docker build
    docker build -t feederbot:1.0.1 .
  2. Run the container:

    # Using docker-compose
    # Supply the BOT_TOKEN and USER_ID environment variables in docker-compose.yml
    docker-compose up -d
    # Using the Docker volume for the reader database
    docker run -d -t -e BOT_TOKEN="<Bot Token>" -e USER_ID="<User ID>" --name feederbot feederbot:1.0.1
    # Using a bind mount for the reader database
    docker run -d -t -e BOT_TOKEN="<Bot Token>" -e USER_ID="<User ID>" -v /path/to/store/db:/usr/src/app/reader --name feederbot feederbot:1.0.1

Authors -- Contributors

dbrennand - Author

License

This project is licensed under the MIT License - see the LICENSE for details.

feederbot's People

Contributors

dbrennand avatar dependabot[bot] 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.