Jackett/README.md

227 lines
8.3 KiB
Markdown
Raw Normal View History

2017-01-27 12:43:17 +00:00
## Jackett
2015-08-25 20:30:32 +00:00
2017-01-21 05:36:04 +00:00
[![GitHub issues](https://img.shields.io/github/issues/Jackett/Jackett.svg?maxAge=60&style=flat-square)](https://github.com/Jackett/Jackett/issues)
[![GitHub pull requests](https://img.shields.io/github/issues-pr/Jackett/Jackett.svg?maxAge=60&style=flat-square)](https://github.com/Jackett/Jackett/pulls)
[![Github Releases](https://img.shields.io/github/downloads/Jackett/Jackett/total.svg?maxAge=60&style=flat-square)](https://github.com/Jackett/Jackett/releases/latest)
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/jackett.svg?maxAge=60&style=flat-square)](https://hub.docker.com/r/linuxserver/jackett/)
2015-10-29 20:07:11 +00:00
This project is a new fork and is recruiting development help. If you are able to help out please contact us.
2015-08-25 20:30:32 +00:00
2017-01-20 12:50:50 +00:00
Jackett works as a proxy server: it translates queries from apps ([Sonarr](https://github.com/Sonarr/Sonarr), [Radarr](https://github.com/Radarr/Radarr), [SickRage](https://sickrage.github.io/), [CouchPotato](https://couchpota.to/), [Mylar](https://github.com/evilhero/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.
2015-08-25 20:30:32 +00:00
2016-09-18 14:31:30 +00:00
Developer note: The software implements the [Torznab](https://github.com/Sonarr/Sonarr/wiki/Implementing-a-Torznab-indexer) (with [nZEDb](https://github.com/nZEDb/nZEDb/blob/dev/docs/newznab_api_specification.txt) category numbering) and [TorrentPotato](https://github.com/RuudBurger/CouchPotatoServer/wiki/Couchpotato-torrent-provider) APIs.
2015-11-18 20:00:26 +00:00
2015-08-25 20:30:32 +00:00
#### Supported Systems
* Windows using .NET 4.5
2017-01-29 14:06:31 +00:00
* Linux and OSX using Mono 4 (mono 3 is no longer supported).
2015-08-25 20:30:32 +00:00
#### Supported Public Trackers
* EZTV
* Isohunt
* KickAssTorrent
* KickAssTorrent (kat.how clone)
* LimeTorrents
* RARBG
* Sky torrents
* The Pirate Bay
2015-11-18 20:00:26 +00:00
#### Supported Private Trackers
2017-01-24 17:45:34 +00:00
* 2 Fast 4 You
2017-01-03 18:01:05 +00:00
* 7tor
2016-01-09 02:08:39 +00:00
* Abnormal
2015-11-18 20:00:26 +00:00
* AlphaRatio
2016-11-24 07:40:49 +00:00
* AlphaReign
* Andraste
2015-11-18 20:00:26 +00:00
* AnimeBytes
* AnimeTorrents
2017-01-17 16:12:01 +00:00
* AOX
* Apollo (XANAX)
2015-11-18 20:00:26 +00:00
* Avistaz
2016-09-04 08:24:21 +00:00
* BakaBT
2015-11-18 20:00:26 +00:00
* bB
* Best Friends
2015-11-18 20:00:26 +00:00
* BeyondHD
2016-09-07 15:29:56 +00:00
* Bit-City Reloaded
2015-11-18 20:00:26 +00:00
* BIT-HDTV
2016-12-29 14:31:12 +00:00
* BitHQ
2017-01-05 18:14:41 +00:00
* BitHUmen
2015-11-18 20:00:26 +00:00
* BitMeTV
2016-01-03 20:40:59 +00:00
* BitSoup
2017-01-12 18:13:36 +00:00
* Bitspyder
2016-11-27 18:07:33 +00:00
* Blu-bits
2017-01-20 17:34:24 +00:00
* BlueBird
2015-11-18 20:00:26 +00:00
* BTN
2016-12-30 14:20:11 +00:00
* CHDBits
2016-09-18 14:27:21 +00:00
* CinemaZ
2015-11-20 10:50:33 +00:00
* DanishBits
2016-12-20 11:39:57 +00:00
* DataScene
2015-11-20 10:50:33 +00:00
* Demonoid
* DigitalHive
2017-01-20 16:35:44 +00:00
* Dream Team
2016-11-21 18:07:09 +00:00
* EoT-Forum
2017-01-17 14:01:39 +00:00
* eStone
2016-11-23 09:19:38 +00:00
* Ethor.net (Thor's Land)
2016-12-21 17:18:25 +00:00
* FANO.IN
2015-11-18 20:00:26 +00:00
* FileList
2017-01-11 17:59:11 +00:00
* Freedom-HD
2015-11-18 20:00:26 +00:00
* Freshon
2016-09-18 14:22:59 +00:00
* FunFile
2017-01-10 17:52:13 +00:00
* FunkyTorrents
2016-04-01 11:39:37 +00:00
* Fuzer
2017-01-30 17:04:18 +00:00
* GFXPeers
2016-09-06 11:50:16 +00:00
* Ghost City
* GimmePeers
2017-01-17 15:05:57 +00:00
* GODS
2016-12-15 08:32:11 +00:00
* Gormogon
2017-01-17 16:49:43 +00:00
* Hardbay
2016-11-15 08:17:55 +00:00
* HD4Free
2015-11-18 20:00:26 +00:00
* HD-Space
* HD-Torrents
2016-12-23 16:35:30 +00:00
* HDClub
2017-01-30 17:22:42 +00:00
* HDHome
2017-01-03 12:21:07 +00:00
* HDSky
* Hebits
2017-01-20 17:07:50 +00:00
* Hon3y HD
2015-11-20 10:50:33 +00:00
* Hounddawgs
* House-of-Torrents
2017-01-20 17:07:50 +00:00
* Hyperay
2016-12-19 18:51:54 +00:00
* ICE Torrent
2015-11-18 20:00:26 +00:00
* Immortalseed
2017-01-12 11:18:22 +00:00
* Infinity-T
2017-01-27 14:44:40 +00:00
* inPeril
2015-11-18 20:00:26 +00:00
* IPTorrents
2017-01-26 15:03:36 +00:00
* JPopsuki
2017-01-30 18:33:25 +00:00
* Le Paradis Du Net
2017-01-18 18:59:35 +00:00
* LinkoManija
2017-01-03 13:54:36 +00:00
* M-Team - TP
2017-01-18 20:43:22 +00:00
* Magico
* Mononoké-BT
2015-11-20 10:50:33 +00:00
* MoreThanTV
2016-04-20 10:14:55 +00:00
* MyAnonamouse
* myAmity
2016-12-09 16:01:01 +00:00
* MySpleen
2017-01-12 16:22:34 +00:00
* Nachtwerk
2015-11-20 10:50:33 +00:00
* NCore
2016-12-09 15:21:56 +00:00
* NetHD
2017-01-12 14:31:53 +00:00
* New Real World
2015-11-18 20:00:26 +00:00
* NextGen
2016-12-06 17:39:21 +00:00
* Norbits
* nostream
2016-12-18 10:36:11 +00:00
* notwhat.cd
2016-12-17 15:49:52 +00:00
* PassTheHeadphones
* PassThePopcorn
* PirateTheNet
2017-01-28 05:50:51 +00:00
* PiXELHD
2016-08-18 10:55:58 +00:00
* Pretome
2015-11-18 20:00:26 +00:00
* PrivateHD
2016-12-17 16:33:34 +00:00
* QcTorrent
2016-12-23 13:56:31 +00:00
* RapideTracker
2015-12-28 11:50:33 +00:00
* RevolutionTT
2017-01-12 17:32:33 +00:00
* Rockhard Lossless
2017-01-05 16:36:49 +00:00
* RuTracker
2015-11-18 20:00:26 +00:00
* SceneAccess
* SceneFZ
2015-11-18 20:00:26 +00:00
* SceneTime
2016-12-05 14:14:16 +00:00
* SDBits
2016-12-05 17:01:11 +00:00
* Secret Cinema
2016-11-02 18:18:33 +00:00
* Shareisland
2017-01-10 18:06:47 +00:00
* ShareSpaceDB
2015-11-18 20:00:26 +00:00
* Shazbat
2017-01-11 17:17:40 +00:00
* Shellife
2015-11-20 10:50:33 +00:00
* SpeedCD
2017-01-06 18:04:46 +00:00
* Superbits
2016-11-20 12:22:59 +00:00
* The Horror Charnel
2016-11-15 18:37:13 +00:00
* The New Retro
2016-11-29 13:20:23 +00:00
* The Shinning
2015-11-18 20:00:26 +00:00
* TehConnection
2016-12-08 05:38:18 +00:00
* TenYardTracker
* Torrent Network
2016-11-19 11:57:13 +00:00
* Torrent Sector Crew
* Torrent411
2016-11-29 18:35:49 +00:00
* TorrentBD
2015-11-18 20:00:26 +00:00
* TorrentBytes
* TorrentDay
* TorrentHeaven
2017-01-31 10:01:08 +00:00
* TorrentHR
2017-01-06 16:07:52 +00:00
* Torrenting
2015-11-18 20:00:26 +00:00
* TorrentLeech
2016-12-20 18:43:08 +00:00
* Torrents.Md
2015-11-18 20:00:26 +00:00
* TorrentShack
2016-09-07 12:00:25 +00:00
* Torrent-Syndikat
2016-12-10 12:49:39 +00:00
* ToTheGlory
2016-12-27 18:13:01 +00:00
* TranceTraffic
2016-05-14 12:44:49 +00:00
* TransmitheNet
2015-11-18 20:00:26 +00:00
* TV Chaos UK
2016-11-19 10:33:00 +00:00
* TV-Vault
2016-12-20 12:20:12 +00:00
* u-Torrent
2016-11-20 12:58:29 +00:00
* UHDBits
2017-01-26 11:38:14 +00:00
* ULTRAHDCLUB
2015-12-29 11:07:34 +00:00
* World-In-HD
2016-11-01 21:46:21 +00:00
* WorldOfP2P
* x264
2016-01-03 20:40:59 +00:00
* XSpeeds
2016-04-03 18:31:44 +00:00
* Xthor
2016-12-19 19:57:38 +00:00
* Xtreme Zone
2015-08-25 20:30:32 +00:00
2015-09-21 18:42:17 +00:00
#### Installation on Windows
We recommend you install Jackett as a Windows service using the supplied installer. You may also download the zipped version if you would like to configure everything manually.
2015-09-21 18:42:17 +00:00
To get started with using the installer for Jackett, follow the steps below:
1. Download the latest version of the Windows installer, "Jackett.Installer.Windows.exe" from the [releases](https://github.com/Jackett/Jackett/releases/latest) page.
2. When prompted if you would like this app to make changes to your computer, select "yes".
3. If you would like to install Jackett as a Windows Service, make sure the "Install as Windows Service" checkbox is filled.
4. Once the installation has finished, check the "Launch Jackett" box to get started.
5. Navigate your web browser to: http://127.0.0.1:9117
6. You're now ready to begin adding your trackers and using Jackett.
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 if you would like to see log messages (Ensure the server isn't already running from the tray/service). This can be done by using "JackettConsole.exe" (for Command Prompt), found in the Jackett data folder: "%ProgramData%\Jackett".
2015-09-21 18:42:17 +00:00
2015-08-25 20:30:32 +00:00
#### Installation on Linux/OSX
1. Install [Mono 4](http://www.mono-project.com/download/) or better
* Follow the instructions on the mono website and install the `mono-devel` package.
* On Red Hat/CentOS/openSUSE the `mono-locale-extras` package is also required
2015-08-25 20:30:32 +00:00
2. Install libcurl:
* Debian/Ubunutu: `apt-get install libcurl-dev`
* Redhat/Fedora: `yum install libcurl-devel`
2015-08-25 20:30:32 +00:00
* For other distros see the [Curl docs](http://curl.haxx.se/dlwiz/?type=devel).
3. Download and extract the latest `Jackett.Binaries.Mono.tar.gz` release from the [releases page](https://github.com/Jackett/Jackett/releases) and run Jackett using mono with the command `mono JackettConsole.exe`.
Detailed instructions for [Ubuntu 14.x](http://www.htpcguides.com/install-jackett-on-ubuntu-14-x-for-custom-torrents-in-sonarr/) and [Ubuntu 15.x](http://www.htpcguides.com/install-jackett-ubuntu-15-x-for-custom-torrents-in-sonarr/)
2015-08-25 20:30:32 +00:00
2017-01-21 05:36:04 +00:00
#### Installation using Docker
Detailed instructions are available at [LinuxServer.io Jackett Docker](https://hub.docker.com/r/linuxserver/jackett/). The Jackett Docker is highly recommended, especially if you are having Mono stability issues or having issues running Mono on your system eg. QNAP, Synology. Thanks to [LinuxServer.io](https://linuxserver.io)
2015-09-21 18:42:17 +00:00
#### Installation on Synology
2015-12-06 19:48:10 +00:00
Jackett is available as beta package from [SynoCommuniy](https://synocommunity.com/)
2015-08-25 20:30:32 +00:00
#### 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). You can also try running with the "--IgnoreSslErrors true" option which is useful if the site has an invalid SSL certificate.
2015-08-25 20:30:32 +00:00
* 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.
2015-11-20 10:37:46 +00:00
#### Creating an issue
Please supply as much information about the problem you are experiencing as possible. Your issue has a much greater chance of being resolved if logs are supplied so that we can see what is going on. Creating an issue with '### isn't working' doesn't help anyone to fix the problem.
2015-10-02 16:58:58 +00:00
### Contributing
2017-01-23 14:55:09 +00:00
All contributions are welcome just send a pull request. 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 but are not a developer then feel free to leave a request on the [issues page](https://github.com/Jackett/Jackett/issues). It is recommended to use Visual studio 2015 when making code changes in this project.
2015-08-25 20:30:32 +00:00
### Screenshots
2016-12-05 17:43:04 +00:00
![screenshot](https://i.imgur.com/0d1nl7g.png "screenshot")