Join GitHub today
GitHub is home to over 31 million developers working together to host and review code, manage projects, and build software together.Sign up
This plugin is designed to fetch torrents via rss download links. It has 2 main parts, one for entering feeds, the other for setting up filters. For more information about rss, see wiki.
Adding a feed
To add a feed, right click the RSS icon on the left hand side of the screen and select "Add RSS Feed" as shown in the next two images. (note: prior to r890 you can also use the feed icon on the top menu bar, in r890 this was changed to open the rss manager).
This should bring up a new window, as shown in the next image:
You need to add your RSS feed where it says "Feed URL" and give it a name where it says "Custom Alias" (note: It's important that you always use a DOWNLOAD feed. If you use a web feed, you will end up with errors. Also, it's important to note that some feeds require cookies to use. These feeds will require you to use the cookies plugin).
If you added the feed correctly, you should end up with something like this:
With this, you have everything you need to manually download torrents via rss feed. To manually download items from this feed, right click on the item and select "Load", as shown in this screenshot:
This should bring up an "Add Torrent" window like this:
if you click "OK", it will add it and download it to your default dir
if you select "Don't start the download automatically" the torrent will be added in the program "Stopped"
If all went well, you should have a downloading torrent as shown here:
Automatic Downloading via RSS Manager
Manually adding torrents via a feed is somewhat convenient but lets face it, if you are going to add rss feed, you probably want to automate downloading. Now that you know how to add feeds, it's time to create filters.
To Open the rss manager, right click on the RSS icon from the left side of the menu, and select "RSS Manager" (note: as of r890 you can use the rss icon from the top bar to bring up the rss manager).
The filter manager has SEVERAL options/settings so rather than give you a step by step, i'm going to post a pic explaining what each option does.
- Add: This adds a new filter rule.
- Filter: This is where you put the filter regex.
- Exclude: This is where you put the exclude regex.
- Check Fields: This is where you decide what the filter should match against
Title Field: This is the title of the RSS entry.
Description field: This is the description data for the rss item.
Link Field: This is the http link for the rss item.
(The default is to use only the "Title Field", if you use the others, make sure you know what you are doing, otherwise it could lead to unwanted matches).
- Directory: This is the save path for the torrent data, having _getdir plugin helps here.
- Match Interval: This is the rate at which the filter will download new torrents (the default is always).
- Label: This is the label for ruTorrent, used mainly to sort the list of seeding torrents (note: if you use auto-tools, and leave this blank, it will automatically label the torrent based on normal auto-tools rules).
- RatioGroup: This is the ratio group you want the matched torrents to be in. (Plugin ratio must be installed).
- Channel: This is the download/upload channel you want the matched torrents in. (Plugin throttle must be installed).
- Download options: These define behavior for matched torrents, don't add the torrent's name to path or don't start download automatically (torrent added to list in "stopped" format).
So to add a filter, just click the "Add" button (1). This will create an empty filter rule, give it a name, and enter your regex filter in the Filter section (2).
(For more info on regex, see here. Also, regex filters in ruTorrent need to be enclosed in
/ /i tags, you could use other tags, but this is the standard, case insensitive tag). An example of a filter might be:
If you wish to exclude items from your filter, you could code this into the standard filter, but it's much more simple to use the "Exclude" option (3). The syntax for this field is the same as the "Filter" field, a standard exclude might look like this:
For (4) the default is often the desired case, the other 2 options are used much less often. The description field is the RSS description, or category. The link field is the actual HTTP link. Using these check boxes allows you to match text in these areas.
For (5) you set the download path. This can come in great handy when using plugin AutoTools.
Most of the other options have already been explained or are self explanatory. If you have any questions, be sure to ask in the forums.
You can add as many filters as you like. To disable a filter, you can click the check box next to the filter's name.
Renaming a Feed
To rename a feed, right click on the feed and select "Edit Feed".
This should open a window with the feed name and path, allowing you to rename the feed.
Using feeds that require HTTP authentication
For feeds that require HTTP authentication, simply use this format for the feed URL:
Using feeds that require cookies
To use feeds that require cookies, you must find the cookie for the site, and grab UID and pass from it.
- IE users will find their cookies in
- Firefox users will find their cookies in Tools -> Options -> Privacy -> Show Cookies
- Opera users will find their cookies in Tools -> Advanced -> Cookies
- Users of other browsers will have to consult their browser's documentation. Once you have the necessary information, use this format for the feed URL:
Another way to inform ruTorrent about required cookies is provided via plugin Cookies.
rss will automatically start when you load the webui, but if for some reason your server reboots, you might wish to have it start automatically. See How to start plugins with rtorrent for details.