Jackett/README.md at 943776569728f95386f28b2ef03225e6cab5bb72

5.9 KiB

Raw Blame History

Jackett

Download

Overview

This software creates a Torznab (with nZEDb category numbering) and TorrentPotato API server on your machine. Torznab enables software such as Sonarr to access data from your favorite indexers in a similar fashion to rss but with added features such as searching. TorrentPotato is an interface accessible to CouchPotato.

Jackett works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.

We were previously focused on TV but are working on extending searches to allow for searching other items such as movies, comics, and music.

Supported Systems

Windows using .NET 4.5
Linux and OSX using Mono 4 (v3 should work but you may experience crashes).

Supported Trackers

Installation on Windows

Grab the latest release from the website.

We recommend you install Jackett as a Windows service using the supplied installer. When installed as a service the tray icon acts as a way to open/start/stop Jackett. If you opted to not install it as a service then Jackett will run its web server from the tray tool.

Jackett can also be run from the command line using JackettConsole.exe if you would like to see log messages (Ensure the server isn't already running from the tray/service).

Installation on Linux/OSX

Install Mono 4 or better
Install libcurl:
- Debian/Ubunutu: apt-get install libcurl-dev
- Redhat/Fedora: yum install libcurl-devel
- For other distros see the Curl docs.
Download and extract the latest .tar.bz2 release from the website and run Jackett using mono with the command "mono JackettConsole.exe".

Installation on Synology

Install Sonarr & Mono 3.10 from synocommunity.
Install Mono beta 3.12 from the main Synology repo (Or newer if available).
Download jackett and place it in /opt/Jackett
cd /opt
chown -R {user who will run jackett} Jackett
Copy Upstart.config to /etc/init/jackett.conf and replace the braces {} in the script with the username that you wish to run Jackett with.
From anywhere on command line type "start jackett" . You should see output telling you that Jackett is running and you should be able to browse to {IP Address}:9117 . If not you should check /var/log/upstart/jackett.log and see what that says.

Troubleshooting

Command line switches

You can pass various options when running via the command line, see --help for details.

Unable to connect to certain trackers on Linux

Try running with the "--SSLFix true" if you are on Redhat/Fedora/NNS based libcurl. If the tracker is currently configured try removing it and adding it again. Alternatively try running with a different client via --UseClient (Warning: safecurl just executes curl and your details may be seen from the process list).

Enable logging

You can get additional logging with the switches "-t -l". Please post logs if you are unable to resolve your issue with these switches ensuring to remove your username/password/cookies.

Additional Trackers

Jackett's framework allows our team (and any other volunteering dev) to implement new trackers in an hour or two. If you'd like support for a new tracker then feel free to leave a request on the issues page or contact us on IRC (see below). Pull requests must be made to the develop branch.

Contact & Support

Use the github issues pages or talk to us directly at: irc.freenode.net#jackett.

5.9 KiB Raw Blame History