Skip to content

Latest commit

 

History

History
128 lines (92 loc) · 4.26 KB

README.en.md

File metadata and controls

128 lines (92 loc) · 4.26 KB
Raw

rssbot Build Status Github All Releases

Other Languages: Chinese

Telegram RSS bot @RustRssBot

Supports:

  • RSS 0.9
  • RSS 0.91
  • RSS 0.92
  • RSS 0.93
  • RSS 0.94
  • RSS 1.0
  • RSS 2.0
  • Atom 0.3
  • Atom 1.0
  • JSON Feed 1

Usage

/rss       - Display a list of currently subscribed RSS feeds
/sub       - Subscribe to an RSS: /sub http://example.com/feed.xml
/unsub     - Unsubscribe from an RSS: /unsub http://example.com/feed.xml
/export    - Export to OPML

Download

The pre-compiled binaries can be downloaded directly from Releases. Make sure to use the english binary (rssbot-en-amd64-linux). The Linux version is statically linked to musl, no other dependencies required.

Compile

Please try to download from the Link above, if that's not feasible or you have other requirements you should compile manually

Install Rust Nightly and Cargo (rustup recommended) first, then:

LOCALE=en cargo build --release

The compiled files are available at: ./target/release/rssbot

Run

A simple Telegram RSS bot.

USAGE:
    rssbot [FLAGS] [OPTIONS] <token>

FLAGS:
    -h, --help          Prints help information
        --insecure      DANGER: Insecure mode, accept invalid TLS certificates
        --restricted    Make bot commands only accessible for group admins
    -V, --version       Prints version information

OPTIONS:
        --admin <user id>...        Private mode, only specified user can use this bot. This argument can be passed
                                    multiple times to allow multiple admins
        --api-uri <tgapi-uri>       Custom telegram api URI [default: https://api.telegram.org/]
    -d, --database <path>           Path to database [default: ./rssbot.json]
        --max-feed-size <bytes>     Maximum feed size, 0 is unlimited [default: 2097152]
        --max-interval <seconds>    Maximum fetch interval [default: 43200]
        --min-interval <seconds>    Minimum fetch interval [default: 300]

ARGS:
    <token>    Telegram bot token

NOTE: You can get <user id> using bots like @userinfobot @getidsbot

Please read the official docs to create a token.

Environment variables

  • HTTP_PROXY: Proxy for HTTP
  • HTTPS_PROXY: Proxy for HTTPS
  • RSSBOT_DONT_PROXY_FEEDS: Set to 1 to limit the proxy to Telegram requests
  • NO_PROXY: Not supported yet, wait for reqwest#877

Migrating from the old RSSBot

For the original version of Clojure Bot , you can use the following script to convert the database:

#!/bin/bash

DATABASE=$1
TARGET=$2

DATA=$(echo "SELECT url, title FROM rss;" | sqlite3 $DATABASE)
IFS=$'\n'

echo -e "[\c" > $TARGET
for line in ${DATA[@]}
do
    IFS='|'
    r=($line)
    link=${r[0]}
    title=${r[1]}

    echo -e "{\"link\":\"$link\"," \
            "\"title\":\"$title\"," \
            "\"error_count\":0," \
            "\"hash_list\":[]," \
            "\"subscribers\":[\c" >> $TARGET

    subscribers=$(echo "SELECT subscriber FROM subscribers WHERE rss='$link';" | sqlite3 $DATABASE)
    IFS=$'\n'
    for subscriber in ${subscribers[@]}
    do
        echo -e "$subscriber,\c" >> $TARGET
    done

    echo -e "]},\c" >> $TARGET
done
echo "]" >> $TARGET
sed -i "s/,]/]/g" $TARGET

Parameter 1 is the old database path, parameter 2 is the resulting output JSON path.

It should be noted that the RSS records that have been pushed will not be marked. If the converted database is used directly, the old RSS will be pushed repeatedly when the script is called again.

License

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.