The configuration is a hierarchy constructed of various components. The main component of any config are the feeds, so we will start there. (Do not confuse this with an RSS feed. A 'feed' in FlexGet is more akin to a 'task', and may be renamed as such in the future.)
feeds:
The line ends in a colon, which means we will be defining this section on the lines following. We then indent (2 spaces) everything that belongs to this section. The feeds sections is made up of all your individual feeds, which can be named whatever we want. Let's make one called test feed
.
feeds:
test feed:
This line also ends with a colon, which means we will be defining what belongs in this feed on the following lines, with another indent (2 more spaces.) The contents of an individual feed are always plugins. There are three main types of plugins we normally want in a feed, an input (where do you want FlexGet to look for things?), a filter (which of those things do you want?) and an output (what do you want FlexGet to do with those things?). Let's start by adding an input plugin to our feed, test feed
. In this case we will use the rss plugin as our input.
feeds:
test feed:
rss:
We aren't finished yet, this line ends with a colon, which means we need to provide the next section, which would be the options for the rss plugin. When configuring any plugin, visit that plugin's wiki page to find out what format the options for that plugin should be in. The most simple configuration format for the rss plugin allows us to just define the url for the rss feed.
feeds:
test feed:
rss: http://mysite.com/myfeed.rss
Our input plugin will create an entry for every item that comes into the rss feed, but we still need to tell FlexGet which of those items we want. We do this with a filter plugin. One of the most common is the series plugin, so we will configure that here. This plugin will belong to our test feed
so we remain at the same indentation level, 2 more spaces than test feed
.
feeds:
test feed:
rss: http://mysite.com/myfeed.rss
series:
Now we must consult the series wiki page to determine how to configure the series plugin. There are two formats the series plugin configuration can take, we will stick with the simple one in this tutorial. (eventually you may want to switch to the grouped format) In the simple format, the series plugin just takes a list of the series you want. Since our last line ended with a colon, we go to the next line with 2 more spaces. Each item in our list will be at this same indentation level, and start with '- ' so:
feeds:
test feed:
rss: http://mysite.com/myfeed.rss
series:
- My Favorite Show
The series plugin also allows defining options per show, which we will do with our next show.
feeds:
test feed:
rss: http://mysite.com/myfeed.rss
series:
- My Favorite Show
- Another Good Show:
Since we are defining options for this show, we ended the line with a colon. This normally means we define the options on the next line with 2 more spaces. There is a slight exception when defining options for a list item, in that we have to go 2 more spaces than the actual word, for a total of 4 spaces. Here we will define the quality
option of the series plugin to only allow 720p copies of this show to be downloaded.
feeds:
test feed:
rss: http://mysite.com/myfeed.rss
series:
- My Favorite Show
- Another Good Show:
quality: 720p
Now that we have an input and a filter plugin, we need to tell FlexGet what we want to do with the entries that are accepted by our filter. We do this with an output plugin. One common output plugin is the download plugin, which we could use to save our items to a watch directory from a bittorrent or nzb client. (if you are using deluge or transmission you may want to consider using its dedicated output plugin instead)
feeds:
test feed:
rss: http://mysite.com/myfeed.rss
series:
- My Favorite Show
- Another Good Show:
quality: 720p
download:
The download plugin also has a very simple configuration option, in which we can just define the path where we would like it to save our content.
feeds:
test feed:
rss: http://mysite.com/myfeed.rss
series:
- My Favorite Show
- Another Good Show:
quality: 720p
download: /home/me/watchdir/
Congratulations, we now have a fully functioning config file. You can continue to add more feeds to your config file to complete different tasks, or customize this one further. Remember to consult the plugins wiki page to choose your plugins, and read the individual page for each plugin to figure out how to configure that specific plugin.
**Now just sit back, and let FlexGet do the work for you! **