#rss #transmission #torrent

bin+lib transmission-rss

A simple binary to add RSS torrent items to transmission

7 releases

0.3.1 Jul 19, 2022
0.3.0 Jul 19, 2022
0.2.3 May 4, 2022
0.1.2 Apr 30, 2022

#19 in #transmission

MIT license

23KB
299 lines

transmission-rss

A simple binary that reads a config file with a list of rss torrent items and adds them to transmission.

  • Telegram notification
  • Concurrent rss fetch and processing
  • Helm chart to deploy in a Kubernetes cluster
  • Docker container to use directly or with docker-compose
$ transmission-rss
USAGE:
    transmission-rss --config <CONFIG>

OPTIONS:
    -c, --config <CONFIG>    Path to the config file
    -h, --help               Print help information
    -V, --version            Print version information
                                                        

Getting started

If you have cargo installed it's possible to install the binary by running:

$ cargo install transmission-rss
$ transmission-rss -c config.toml
----------------------------
==> Processing [RSS New Linux Distros]
10 items processed
        

Config file

Example of config.toml:

[persistence]
path = "/path/to/db/folder"

[transmission]
url = "http://myserver/transmission/rpc"
username = "myusername"
password = "mypassword"

[notification.telegram]
bot_token = 123123:your_token
chat_id = 123123

[[rss_list]]
title = "My List"
url = "https://someweb.site/rss.xml"
filters = ["1080p"]
download_dir = "/downloads/my_folder"

The password and telegram bot token can optionally be loaded from separate files by specifying password_file/bot_token_file instead.

Docker

It's also possible to run the docker container directly or using docker-compose.yml.

$ docker run -v ./persistence:/persistence ghcr.io/herlon214/transmission-rss:v0.2.2 -- -c /persistence/config.toml

Kubernetes

You can also use the helm chart in the helm/ for deploying in your kubernetes cluster. Create your config map and update the configMapName when deploying the helm chart.

ConfigMap example:

apiVersion: v1
kind: ConfigMap
metadata:
  name: transmission-rss-cm
data:
  config.toml: |
    [persistence]
    path = "/db"

    [transmission]
    url = "http://yourserver/transmission/rpc"
    username = "username"
    password = "password"

    [notification.telegram]
    bot_token = "123:token"
    chat_id = 123123

    [[rss_list]]
    title = "My Item"
    url = "https://rss.link/here"
    filters = ["1080p"]
    download_dir = "/path/to/store"
                    

Dependencies

~18–35MB
~632K SLoC