rss-o-bot

RSS-o-Bot 0.4.6

A super simple RSS client.

Documentation

Refer to the Online man-page or man rss-o-bot.

Installation

npm i -g rss-o-bot

Your RSS-o-Bot, will search for a configuration file in ~/.rss-o-bot. Here's an example configuration:

{
  "notification-methods": ["telegram", "desktop"],
  "telegram-api-token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "telegram-recipients": ["00000000"],
  "interval": 100,
  "database": {
    "name": "data",
    "username": null,
    "password": null,
    "options": {
      "dialect": "sqlite",
      "storage": "/home/myuser/.rss-o-bot.sqlite"
    }
  }
}

Usage

rss-o-bot -h

Daemonizing

If you're using linux you'll probably want to go with systemd. Figure it out yourself.

If not, you probably want to use pm2. It provides a really powerful, yet simple to use system for process-daemonization (LOL).

npm i -g pm2
pm2 start rss-o-bot

If you haven't yet, I'd make pm2 services start upon reboot.

pm2 startup [platform] # Refer to `pm2 -h` for available platforms

Development

Before committing, use npm run build to build the man page and the JS.

TODO

• Multi-threading
• Replace the request library
• Fix the memory leak