El Monitorro

El Monitorro is a high-performance RSS/ATOM/JSON feed reader as a Telegram bot. It's available at https://t.me/el_monitorro_bot

Star Fork
Explore More ⇩
Overview

paypal

El Monitorro

El Monitorro is RSS, Atom and JSON feed reader as a Telegram bot.

It's available at @el_monitorro_bot.

Usage

Commands

/start - show the bot's description and contact information

/subscribe url - subscribe to feed

/unsubscribe url - unsubscribe from feed

/list_subscriptions - list your subscriptions

/help - show available commands

/set_timezone - set your timezone. All received dates will be converted to this timezone. It should be offset in minutes from UTC. For example, if you live in UTC +10 timezone, offset is equal to 600

/get_timezone - get your timezone

/set_template url template - set a template for all received items for the specified subscription. All new updates will be converted to the format defined by this subscription. Supported fields you can use for templates:
- bot_feed_name - name of the feed
- bot_feed_link - url of the feed
- bot_item_name - name of the item
- bot_item_link - url of the item
- bot_item_description - description of the item
- bot_date - publication date of the feed
- bot_space - defines a space character
- bot_new_line - defines a new line character
Example: /set_template https://www.badykov.com/feed.xml bot_datebot_spacebot_item_namebot_new_linebot_item_description.

/get_template url - get a template for the subscription

/set_global_template - set global template. This template will be used for all subscriptions. If the subscription has its own template, the subscription template will be used. See /set_template for available fields.

/get_global_template - get global template

/get_filter url - get a filter for the subscription

/set_filter url template - set filter, for example, /set_filter https://www.badykov.com/feed.xml telegram,bots. You'll start receiving posts only containing words in the filter. Use `!word` to stop receiving messages containing the specified `word`. You can combine regular filter words with ! filter words. For example, `!bot,telegram`

/remove_filter url - remove filter

Common info

The bot works in private chats, groups and channels. A couple of channels created with el monitorro:

Setup

Manual setup

You can deploy your instance of el_monitorro by:

  1. Set postgres db url (DATABASE_URL) and telegram bot token (TELEGRAM_BOT_TOKEN) to .env file in the root directory. For example:
DATABASE_URL=postgres://admin:pass@localhost/el_monitorro
TELEGRAM_BOT_TOKEN=MYTOKEN
  1. Setup database by running:
diesel database setup

You'll need diesel-cli for this

  1. Start the bot
RUST_LOG=info RUST_BACKTRACE=1 cargo run --bin el_monitorro
RUST_LOG=info RUST_BACKTRACE=1 cargo run --bin sync
RUST_LOG=info RUST_BACKTRACE=1 cargo run --bin deliver
RUST_LOG=info RUST_BACKTRACE=1 cargo run --bin cleaner

Running all services from a single binary

Set ALL_BINARIES to run all binaries (clean, commands, deliver, sync) in the same binary:

ALL_BINARIES=true

Configuration

All configuration is done through env variables

NameRequiredDefault valueExample / Description
DATABASE_URLyes--postgres://postgres:postgres@localhost/el_monitorro
TELEGRAM_BOT_TOKENyes--6666618370:AAGx5YhNQvUG4eUcQXN-OB_a09ZzYl6aaaa
DATABASE_POOL_SIZEno5Db pool size to process user commands
ALL_BINARIESno--If this var is set, all services will be started in the main binary
TELEGRAM_BOT_HANDLEno--This value is used during parsing of commands. If you set autocompletion menu for your bot, the bot will understand commands like /subscribe@handle along with just /subscribe
SUBSCRIPTION_LIMITno20
SYNC_INTERVAL_SECONDSno60The bot tries to sync feeds every SYNC_INTERVAL_SECONDS seconds
SYNC_WORKERS_NUMBERno1The number of workers to sync feeds
DELIVER_INTERVAL_SECONDSno60The bot tries to deliver new feed items every DELIVER_INTERVAL_SECONDS seconds
DELIVER_WORKERS_NUMBERno1The number of workers to deliver updates
CLEAN_INTERVAL_SECONDSno3600The bot cleans old feed items and feeds without subscriptions every CLEAN_INTERVAL_SECONDS seconds
CLEAN_WORKERS_NUMBERno1The number of workers to remove old data
OWNER_TELEGRAM_IDno--If this value is set, the bot will process commands from the specified chat id
REQUEST_TIMEOUTno5Timeout in seconds for feed syncing requests
ADMIN_TELEGRAM_IDno--If this value is set, /info command with stats is available for ADMIN_TELEGRAM_ID

Using docker image

The image is published on docker hub under ayratbadykov/el_monitorro. It accepts additional env variables:

RUN_MIGRATION=true
BOT_BINARY=commands
ALL_BINARIES=true

Run the docker container:

docker run --env-file ./.env --network host -t ayratbadykov/el_monitorro:latest

Notes:

Creating a docker image from the latest master branch

Run the following command in the el_monitorro directory to build the image from the master branch:

docker build ./ -t ayratbadykov/el_monitorro:latest