Flexget

From Bytesized Wiki

(Difference between revisions)
Jump to: navigation, search
 
(17 intermediate revisions not shown)
Line 1: Line 1:
-
FlexGet is a multipurpose automation tool for content like torrents, nzbs, podcasts, comics, etc. FlexGet is able to handle different kinds of sources like RSS-feeds, html pages and csv files. There are even some plugins for sites that do not provide any kind of useful feeds.
+
FlexGet is a very powerful tool to aggregate and sort RSS feeds automatically and it works well with Deluge.
-
There are numerous plugins that allow utilizing FlexGet in interesting ways and more are being added continuously.
+
<br>FlexGet is a multipurpose automation tool for content like torrents, nzbs, podcasts, comics, etc.  
-
Since the FlexRSS plugin isn’t working in Deluge 1.2.*, I thought I write this workaround for adding torrents through RSS-Feeds. Feel free to add something or correct me if I made a mistake.
+
<br>FlexGet is able to handle different kinds of sources like RSS-feeds, html pages and csv files.  
 +
<br>There are even some plugins for sites that do not provide any kind of useful feeds.
 +
<br>There are numerous plugins that allow utilizing FlexGet in interesting ways and more are being added continuously.
 +
<br>Since the FlexRSS plugin isn’t working in Deluge 1.2.*, I thought I write this workaround for adding torrents through RSS-Feeds.  
 +
<br>Feel free to add something or correct me if I made a mistake.
=Installing FlexGet=
=Installing FlexGet=
 +
'''''If you are on a new server FlexGet is already installed, you can go straight to Configuring FlexGet''''
 +
New users shouldn't be discouraged by the code below, its very straight forward.
 +
<br>To setup: <10 min.
 +
<br>To configure: <60 min (depending on your complexity of the code).
-
FlexGet is a very powerful tool to aggregate and sort rss feeds automatically and it works well with deluge.
 
-
For an introduction see http://blog.bytesized-hosting.com/2010/03/16/the-beauty-of-flexget/
 
-
====Installation:====
+
====Configuring FlexGet====
-
Open the terminal on your box, either through [http://wiki.bytesized-hosting.com/wiki/index.php/VNC VNC] or through [http://wiki.bytesized-hosting.com/wiki/index.php/Command_line#SSH_access SSH].
+
*Type in terminal:
-
*Create virtualenv by typing in terminal:
+
   
-
  virtualenv ~/flexget/
+
   mkdir -p ~/.flexget
-
*Activate virtualenv by typing in terminal:
+
   
-
   source ~/flexget/bin/activate
+
and then
-
*Install latest version for python 2.6 by typing in terminal:
+
-
  easy_install http://download.flexget.com/unstable/FlexGet-1.0r1377-py2.6.egg
+
-
This will install FlexGet and all the required dependencies.
+
-
====Configure FlexGet====
+
   nano ~/.flexget/config.yml
-
*While in your home directory, type in terminal:
+
 
-
   nano ./flexget/config.yml
+
*To save changes to the config file, press Ctrl-O then 'Enter' on your keyboard, then Ctrl-X to close
-
*For configuration options see the blog mentioned above or http://flexget.com/wiki/Configuration
+
-
*Write content of config file with Ctrl-O and close nano with Ctrl-X
+
-
=====Basic config.yml=====
+
====Examples of config.yml files====
-
+
Reading examples below is the easiest way to configure flexget to suit your needs:
-
http://pastebin.com/GdiqFQ9B
+
*Examples from flexget website:
 +
http://flexget.com/wiki/Configuration
 +
<br>http://flexget.com/wiki/Cookbook
 +
*Examples from our blog:<br>
 +
http://blog.bytesized-hosting.com/2010/03/16/the-beauty-of-flexget/
 +
*A user-submitted example of basic configuration:<br>
 +
http://pastebin.com/GdiqFQ9B
 +
*A user-submitted example of advanced configuration:<br>
 +
http://pastebin.com/H6gyipex
 +
*Easy to use software for creating config.yml
 +
http://www.flexgetcfc.co.uk/
-
=====Advanced config.yml=====
+
====Checking FlexGet====
-
http://pastebin.com/H6gyipex
+
*You can check whether your configuration would work by typing:
 +
flexget --test
 +
====Running FlexGet====
-
*You can then let cron run FlexGet every 30 minutes and it downloads new torrents automatically to your watch folder.
+
*You can run Flexget manually by typing:
-
*To edit your crontab, type:
+
flexget
 +
 
 +
====Scheduling FlexGet====
 +
 
 +
*You can automate FlexGet to run frequently such that it downloads new torrents automatically to your watch folder, without manually running flexget.
 +
*To see if flexget is installed on your box, type:
 +
which flexget
 +
*If it returns a path to flexget, it is installed, if not you can ask staff to install it or do it yourself.
 +
*Before you add flexget to cron, it is '''STRONGLY''' advised to run:
 +
flexget --learn
 +
*As above command suggests, it learns all torrents that are already on feed and marks them as seen. So when flexget cron is ran for first time, it wont download and queue 50 torrents at once. If you created cool filters, you wont necessarily need this. If you used accept_all anywhere on config.yml, you'll definitely want to do this.
 +
*To get flexget to run automatically, you must add it to crontab, type:
  crontab -e  
  crontab -e  
-
*This will ask you to choose your prefered editor, select 3 for nano if you are comfortable with this.
+
*This will ask you to choose your prefered editor, select "nano" if you are comfortable with this.
-
*Add the line:
+
*If you're using '''already installed''' flexget, add this line:
-
  */10 * * * * ~/flexget/flexget —cron
+
  */10 * * * * /usr/local/bin/flexget --cron
-
This will run the program every 10 minutes.
+
*To save changes to the crontab file, press Ctrl-O then 'Enter' on your keyboard, then Ctrl-X to close
 +
*If you wish to let flexget run every 10 minutes, '''and you installed it yourself''' add this line:
 +
  */10 * * * * ~/flexget/bin/flexget --cron
 +
*To save changes to the crontab file, press Ctrl-O then 'Enter' on your keyboard, then Ctrl-X to close
 +
*There is no way to confirm that your crontab is working by typing a command in the terminal, so simply wait and see if torrents are being added to deluge automatically. If they are not, there's a mistake in the code mentioned above.
 +
====Installation====
 +
 +
===== Flexget is installed by default =====
 +
 +
''' You should do these steps only if you are sure that flexget is not installed '''
 +
Open the terminal on your box, either through [http://wiki.bytesized-hosting.com/wiki/index.php/VNC VNC] or through [http://wiki.bytesized-hosting.com/wiki/index.php/SSH_access SSH].
 +
*Create virtualenv by typing in terminal:
 +
virtualenv ~/flexget/
 +
*Activate virtualenv by typing in terminal:
 +
source ~/flexget/bin/activate
 +
*Change to ~/flexget directory
 +
cd ~/flexget
 +
*Install latest version of flexget by typing:
 +
easy_install flexget
 +
This will install FlexGet and all the required dependencies.
 +
<br>easy_install automatically gets latest version of flexget
 +
*If you want to upgrade flexget, type:
 +
easy_install --upgrade flexget
 +
*Just to make sure that upgrade went smoothly, type:
 +
flexget --check
 +
 +
 +
====Common problems====
 +
If you use Flexget with an SSL based feed and it's giving you errors, "Unable to download the RSS for task shows (RSS URL): [Errno 1] ssl.c:480: error:14090086:SSL routines:SSL3_GET_SERVERCERTIFICATE:certificate verify failed"  try adding: `verify_ssl_certificates: no` to your config.
 +
 +
 +
====Help====
*This guide is based on http://flexget.com/wiki/InstallWizard/Linux/NoRoot/Virtualenv
*This guide is based on http://flexget.com/wiki/InstallWizard/Linux/NoRoot/Virtualenv
*If the installation fails check this page for the latest links.
*If the installation fails check this page for the latest links.
-
 
+
*If you get stuck using Flexget, simply create a ticket at http://flexget.com/newticket and the members of flexget will help you out. Response time is usually within 30mins.
-
Please Note: You can follow this guy and simply replace the easy_install with the latest version from http://flexget.com/ the only difference is that newer version do not need you to —initdb
+
*If you're using Putty, CTRL+C and CTRL+V doesnt work. So copy any code and right-click with your mouse to paste it in Putty. (Useful for long RSS links)

Current revision as of 20:07, 18 November 2012

FlexGet is a very powerful tool to aggregate and sort RSS feeds automatically and it works well with Deluge.
FlexGet is a multipurpose automation tool for content like torrents, nzbs, podcasts, comics, etc.
FlexGet is able to handle different kinds of sources like RSS-feeds, html pages and csv files.
There are even some plugins for sites that do not provide any kind of useful feeds.
There are numerous plugins that allow utilizing FlexGet in interesting ways and more are being added continuously.
Since the FlexRSS plugin isn’t working in Deluge 1.2.*, I thought I write this workaround for adding torrents through RSS-Feeds.
Feel free to add something or correct me if I made a mistake.

Contents

Installing FlexGet

If you are on a new server FlexGet is already installed, you can go straight to Configuring FlexGet'

New users shouldn't be discouraged by the code below, its very straight forward.
To setup: <10 min.
To configure: <60 min (depending on your complexity of the code).


Configuring FlexGet

  • Type in terminal:
 mkdir -p ~/.flexget

and then

 nano ~/.flexget/config.yml
 
  • To save changes to the config file, press Ctrl-O then 'Enter' on your keyboard, then Ctrl-X to close

Examples of config.yml files

Reading examples below is the easiest way to configure flexget to suit your needs:

  • Examples from flexget website:

http://flexget.com/wiki/Configuration
http://flexget.com/wiki/Cookbook

  • Examples from our blog:

http://blog.bytesized-hosting.com/2010/03/16/the-beauty-of-flexget/

  • A user-submitted example of basic configuration:

http://pastebin.com/GdiqFQ9B

  • A user-submitted example of advanced configuration:

http://pastebin.com/H6gyipex

  • Easy to use software for creating config.yml

http://www.flexgetcfc.co.uk/

Checking FlexGet

  • You can check whether your configuration would work by typing:
flexget --test

Running FlexGet

  • You can run Flexget manually by typing:
flexget

Scheduling FlexGet

  • You can automate FlexGet to run frequently such that it downloads new torrents automatically to your watch folder, without manually running flexget.
  • To see if flexget is installed on your box, type:
which flexget
  • If it returns a path to flexget, it is installed, if not you can ask staff to install it or do it yourself.
  • Before you add flexget to cron, it is STRONGLY advised to run:
flexget --learn
  • As above command suggests, it learns all torrents that are already on feed and marks them as seen. So when flexget cron is ran for first time, it wont download and queue 50 torrents at once. If you created cool filters, you wont necessarily need this. If you used accept_all anywhere on config.yml, you'll definitely want to do this.
  • To get flexget to run automatically, you must add it to crontab, type:
crontab -e 
  • This will ask you to choose your prefered editor, select "nano" if you are comfortable with this.
  • If you're using already installed flexget, add this line:
 */10 * * * * /usr/local/bin/flexget --cron
  • To save changes to the crontab file, press Ctrl-O then 'Enter' on your keyboard, then Ctrl-X to close
  • If you wish to let flexget run every 10 minutes, and you installed it yourself add this line:
*/10 * * * * ~/flexget/bin/flexget --cron
  • To save changes to the crontab file, press Ctrl-O then 'Enter' on your keyboard, then Ctrl-X to close
  • There is no way to confirm that your crontab is working by typing a command in the terminal, so simply wait and see if torrents are being added to deluge automatically. If they are not, there's a mistake in the code mentioned above.

Installation

Flexget is installed by default

You should do these steps only if you are sure that flexget is not installed Open the terminal on your box, either through VNC or through SSH.

  • Create virtualenv by typing in terminal:
virtualenv ~/flexget/
  • Activate virtualenv by typing in terminal:
source ~/flexget/bin/activate
  • Change to ~/flexget directory
cd ~/flexget
  • Install latest version of flexget by typing:
easy_install flexget

This will install FlexGet and all the required dependencies.
easy_install automatically gets latest version of flexget

  • If you want to upgrade flexget, type:
easy_install --upgrade flexget
  • Just to make sure that upgrade went smoothly, type:
flexget --check


Common problems

If you use Flexget with an SSL based feed and it's giving you errors, "Unable to download the RSS for task shows (RSS URL): [Errno 1] ssl.c:480: error:14090086:SSL routines:SSL3_GET_SERVERCERTIFICATE:certificate verify failed" try adding: `verify_ssl_certificates: no` to your config.


Help

  • This guide is based on http://flexget.com/wiki/InstallWizard/Linux/NoRoot/Virtualenv
  • If the installation fails check this page for the latest links.
  • If you get stuck using Flexget, simply create a ticket at http://flexget.com/newticket and the members of flexget will help you out. Response time is usually within 30mins.
  • If you're using Putty, CTRL+C and CTRL+V doesnt work. So copy any code and right-click with your mouse to paste it in Putty. (Useful for long RSS links)
Personal tools