Skip to content

Latest commit

 

History

History
149 lines (100 loc) · 3.12 KB

README.md

File metadata and controls

149 lines (100 loc) · 3.12 KB
Raw

TELEFEED

An RSS/Atom bot for telegram channels

Installation

Make sure that you have installed Redis.

Download binary:

$ curl -L https://github.com/rossnomann/telefeed/releases/download/0.6.0/telefeed-0.6.0_x86_64-linux-gnu --output telefeed
$ chmod +x telefeed

Create config.toml:

token = "bottoken"
redis_url = "redis://127.0.0.1:6379"
# include_feed_title = true  # include feed title to entry link; defaults to false
# request_timeout = 3600  # timeout between requests in seconds; defaults to 1200 (20 minutes)
[[feeds."@channel"]]  # channel username with @
url = "http://www.darkside.ru/rss/"  # url to feed
kind = "rss"  # kind of feed: rss/atom
# request_timeout = 20  # override root value
[[feeds.1234567890]]  # channel ID also supported
url = "https://www.youtube.com/feeds/videos.xml?channel_id=UCX5180-7TnjjHlHaVDdqnmA"
kind = "atom"
# include_feed_title = false  # override root value
[[feeds.1234567890]]
url = "https://www.youtube.com/feeds/videos.xml?channel_id=UC2S1gZS9e8jb3Mx1Ce6YH5g"
kind = "atom"

Run:

./telefeed config.toml

Development

NixOS

Make sure that you have enabled nix flakes and installed direnv.

echo 'use flake' > .envrc
direnv allow

Command for rust analyzer LSP config:

nix develop /path/to/project --command rust-analyzer

To start/stop redis use ./dev/redis-start and ./dev/redis-stop.

To build a release binary use ./dev/build.

Changelog

0.7.0 (07.07.2024)

  • Breaking: Changed configuration file format from YAML to TOML.
  • Added nix dev shell.
  • Updated base64 to 0.22.
  • Updated bytes to 1.6.
  • Updated env_logger to 0.11.
  • Updated redis to 0.25.
  • Updated reqwest to 0.12.
  • Updated tgbot to 0.27.
  • Updated tokio to 1.38.
  • serde_yaml replaced by toml.

0.6.0 (01.01.2024)

  • Updated redis to 0.24.
  • Updated tgbot to 0.20.
  • Updated tokio to 1.35.

0.5.0 (05.12.2023)

  • Updated bytes to 1.5.
  • dotenv replaced by dotenvy.
  • Updated redis to 0.23.
  • Updated tgbot to 0.19.
  • Updated tokio to 1.34.

0.4.0 (04.02.2022)

  • Updated tgbot to 0.17 and tokio to 1.16.
  • Migrated from darkredis to redis-rs.
  • Removed proxy configuration parameter.
  • Added information about url to request error message.

0.3.0 (15.03.2020)

  • Separate fetching of feed entries.
  • Added request_timeout option to root and feed config section.
  • Added include_feed_title option to feed config section.

0.2.3 (20.02.2020)

  • Added include_feed_title option to config. Set it to true when you need to know feed title for each entry.

0.2.2 (31.01.2020)

  • Escape special characters in URL title.

0.2.1 (19.01.2020)

  • Fixed entries duplication.

0.2.0 (17.01.2020)

  • RIIR.

0.1.5 (04.07.2018)

  • Catch exceptions in getUpdates loop

0.1.4 (19.06.2018)

  • Migrate to aiotg.
  • Add http/socks5 proxy support.

0.1.3 (18.05.2018)

  • Exclude entry title from unique constraint.

0.1.2 (15.03.2018)

  • Escape html entities in entry title.
  • Display dates with a timezone.

0.1.1 (11.03.2018)

  • Catch feedparser exceptions.

0.1.0 (09.03.2018)

  • First release.

LICENSE

The MIT License (MIT)