Jackett/README.md

458 lines
16 KiB
Markdown
Raw Normal View History

# Jackett
2017-05-04 19:55:41 +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)
[![Build status](https://ci.appveyor.com/api/projects/status/gaybh5mvyx418nsp/branch/master?svg=true)](https://ci.appveyor.com/project/Jackett/jackett)
2017-05-04 19:55:41 +00:00
[![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/)
[![Discord](https://img.shields.io/badge/discord-chat-7289DA.svg?maxAge=60&style=flat-square)](https://discord.gg/J865QuA)
2017-05-04 19:55:41 +00:00
This project is a new fork and is recruiting development help. If you are able to help out please contact us.
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), [DuckieTV](https://github.com/SchizoDuckie/DuckieTV), 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.
2017-05-04 19:55:41 +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.
#### Supported Systems
* Windows using .NET 4.6.1 or above [Download here](https://www.microsoft.com/net/framework/versions/net461).
2018-06-26 10:21:21 +00:00
* Linux and macOS using Mono 5.8 or above. [Download here](http://www.mono-project.com/download/).
2017-05-04 19:55:41 +00:00
### Supported Public Trackers
* 1337x
2017-05-07 11:27:30 +00:00
* Anidex
* Anime Tosho
* AniRena
* btbit
* BTDB
* BT-Scene
* cpasbien
2017-11-09 12:28:44 +00:00
* ETTV
* ExtraTorrent.ag
2017-05-04 19:55:41 +00:00
* EZTV
* Frozen Layer
2017-09-15 15:08:33 +00:00
* GkTorrent
2017-05-09 18:25:27 +00:00
* Horrible Subs
* Idope
2017-05-04 19:55:41 +00:00
* Il Corsaro Nero <!-- maintained by bonny1992 -->
* Il Corsaro Blu
* Isohunt2
2017-05-04 19:55:41 +00:00
* KickAssTorrent
* KickAssTorrent (thekat.se clone)
2017-05-04 19:55:41 +00:00
* LimeTorrents
* MagnetDL
* MejorTorrent <!-- maintained by ivandelabeldad -->
* Newpct (aka: tvsinpagar, descargas2020, torrentlocura, torrentrapid, etc)
2017-05-14 17:00:15 +00:00
* Nyaa.si
2017-05-06 13:30:00 +00:00
* Nyaa-Pantsu
* Nyoo
2017-05-04 19:55:41 +00:00
* RARBG
* RuTor
2017-05-04 19:55:41 +00:00
* ShowRSS
* sukebei.Nyaa.si
* sukebei-Pantsu
2017-05-04 19:55:41 +00:00
* The Pirate Bay
* TNTVillage <!-- maintained by bonny1992 -->
* Tokyo Toshokan
* Torlock
* Torrent Downloads
* Torrent9
* TorrentKim
2017-05-04 19:55:41 +00:00
* Torrentz2
* World Wide Torrents
* YIFY (YTS)
* YTS.ag
2017-09-15 06:01:10 +00:00
* Zooqle
2018-01-29 18:38:57 +00:00
### Supported Semi-Private Trackers
* 7tor
* CzTorrent
* Deildu
* Gay-Torrents.net
* Gay-Torrents.org
* Kinozal
* LostFilm.tv
* Mega-Bliz
* Metal Tracker
* MVGroup Forum
* MVGroup Main
* Newstudio
* NetHD
* NoName Club
* RuTracker
* SkTorrent
* Union Fansub
* Xtreme Zone
* YggTorrent
* Ztracker
2017-05-04 19:55:41 +00:00
### Supported Private Trackers
* 2 Fast 4 You
* 3D Torrents
* Abnormal
* Acid-Lounge
* AlphaRatio
* AnimeBytes
* AnimeTorrents
* AOX
* Apollo (XANAX)
* ArabaFenice
2017-05-06 13:33:50 +00:00
* Arche Torrent
2017-05-04 19:55:41 +00:00
* AsianDVDClub
2017-09-03 08:03:38 +00:00
* AST4u
2017-05-04 19:55:41 +00:00
* Audiobook Torrents
2017-05-11 19:29:12 +00:00
* Awesome-HD
2017-05-04 19:55:41 +00:00
* Avistaz
* B2S-Share
* Back-ups
2017-05-04 19:55:41 +00:00
* BakaBT [![(invite needed)][inviteneeded]](#)
* bB
* BeyondHD
* BIGTorrent
* Bit-City Reloaded
* BIT-HDTV
2017-12-01 14:27:07 +00:00
* Bithorlo
2017-05-04 19:55:41 +00:00
* BitHUmen
2017-10-26 08:17:42 +00:00
* BitMe
2017-05-04 19:55:41 +00:00
* BitMeTV
* BitSoup [![(invite needed)][inviteneeded]](#)
* Bitspyder
2018-02-16 19:38:11 +00:00
* BitTorrentFiles [![(invite needed)][inviteneeded]](#)
* BJ-Share
2017-05-04 19:55:41 +00:00
* BlueBird
2017-06-23 17:54:09 +00:00
* Blutopia
2018-03-23 11:10:39 +00:00
* Brasil Tracker
2017-08-21 11:06:44 +00:00
* BroadcastTheNet
2017-05-20 14:52:03 +00:00
* BrokenStones
2017-05-04 19:55:41 +00:00
* BTNext
* BTXpress
2017-05-04 19:55:41 +00:00
* Carpathians
2017-12-01 13:13:09 +00:00
* CCFBits
* CGPeers
2017-05-04 19:55:41 +00:00
* CHDBits
* Cinematik
* Cinemageddon
* CinemaZ
* Classix
* DanishBits
* DataScene
* Demonoid
* Diablo Torrent
* DigitalHive
* Downloadville
2017-05-04 19:55:41 +00:00
* Dragonworld Reloaded
* Dream Team
* EliteHD [![(invite needed)][inviteneeded]](#)
* Elit Tracker
* Elite-Tracker
2018-01-05 16:55:39 +00:00
* Empornium
2017-05-04 19:55:41 +00:00
* eStone
* Ethor.net (Thor's Land)
* FANO.IN
* FileList
2018-02-06 16:40:05 +00:00
* Femdomcult
2017-05-04 19:55:41 +00:00
* Freedom-HD
* FullMixMusic
* FunFile
* FunkyTorrents
* Fuzer
* GAYtorrent.ru
2018-02-06 16:40:39 +00:00
* GazelleGames
2017-10-30 03:30:25 +00:00
* Gfxnews
2017-05-04 19:55:41 +00:00
* GFXPeers
2017-09-17 13:02:03 +00:00
* GigaTorrents
2017-05-04 19:55:41 +00:00
* GimmePeers <!-- maintained by jamesb2147 -->
* Girotottent
2017-05-04 19:55:41 +00:00
* GODS [![(invite needed)][inviteneeded]](#)
* Greek Team
* HacheDe
2017-05-04 19:55:41 +00:00
* Hardbay
2017-05-20 15:08:10 +00:00
* HD-Forever
* HD-Only
2017-05-04 19:55:41 +00:00
* HD-Space
* HD-Spain
2017-05-04 19:55:41 +00:00
* HD-Torrents
* HD-Bits.com
* HDBits
* HDChina
* HDCity
2017-05-04 19:55:41 +00:00
* HDHome
* HDME
2017-05-04 19:55:41 +00:00
* HDSky
* HDTorrents.it
* Hebits
* Hon3y HD
* Hyperay
* ICE Torrent
* I Love Classics
* Immortalseed
* inPeril
* Insane Tracker
* IPTorrents
* JPopsuki
* Kapaki
* Karagarga
* LinkoManija
* LosslessClub
* M-Team - TP
* Magico
* Majomparádé
* Manicomio Share
2017-05-04 19:55:41 +00:00
* Mononoké-BT
* MoreThanTV
* MyAnonamouse
* myAmity
* MySpleen
* NCore
* Nebulance
* New Real World
2017-11-13 16:35:01 +00:00
* Norbits <!-- added by DiseaseNO but no longer maintained? -->
2017-05-04 19:55:41 +00:00
* notwhat.cd
* Ourbits
* Passione Torrent <!-- maintained by bonny1992 -->
2018-04-17 08:38:40 +00:00
* PassThePopcorn
2017-05-04 19:55:41 +00:00
* PirateTheNet
* PiXELHD
* PolishSource
* PolishTracker
* Pretome
* PrivateHD
* Psytorrents
2017-05-04 19:55:41 +00:00
* PTFiles
* PuntoTorrent
* Racing4Everyone (R4E)
2017-05-04 19:55:41 +00:00
* Redacted (PassTheHeadphones)
* RevolutionTT
* RGU
2017-05-04 19:55:41 +00:00
* RoDVD
* SceneFZ
2018-01-10 17:55:20 +00:00
* SceneReactor
2017-05-04 19:55:41 +00:00
* SceneTime
* SDBits
* Secret Cinema
* Shareisland
* ShareSpaceDB
* Shazbat
* Shellife
* Speed-Share
2017-05-04 19:55:41 +00:00
* SpeedCD
2017-08-28 13:49:44 +00:00
* SpeedTorrent Reloaded
2017-05-04 19:55:41 +00:00
* SportsCult
* SportHD
2017-05-04 19:55:41 +00:00
* Superbits
* Tasmanit
2018-01-29 18:38:57 +00:00
* TBPlus
2018-07-04 07:48:56 +00:00
* TehConnection.me
2018-04-03 21:00:03 +00:00
* TenYardTracker
2017-05-04 19:55:41 +00:00
* The Empire
* The Geeks
* The Horror Charnel
* The Occult
* The New Retro
* The Place
* The Shinning
* The Show
* The Vault
* The-Torrents
* Torrent Network
* Torrent Sector Crew
* Torrent.LT
2017-05-04 19:55:41 +00:00
* TorrentBD
* TorrentBytes
2017-05-04 19:55:41 +00:00
* TorrentCCF [![(invite needed)][inviteneeded]](#)
* TorrentDay
* Torrentech
2017-05-04 19:55:41 +00:00
* TorrentHeaven
* TorrentHR
* Torrenting
* Torrentland
2017-05-04 19:55:41 +00:00
* TorrentLeech
* Torrents.Md
2018-03-09 17:58:22 +00:00
* TorrentSeeds
2017-05-04 19:55:41 +00:00
* Torrent-Syndikat
* TOrrent-tuRK (TORK)
* TorViet
2017-05-04 19:55:41 +00:00
* ToTheGlory
* TranceTraffic
* Trezzor
2017-05-04 19:55:41 +00:00
* TV Chaos UK
* TV-Vault
* u-torrents (SceneFZ)
2017-05-04 19:55:41 +00:00
* UHDBits
* Ultimate Gamer Club
* Waffles
* World-In-HD
2017-05-04 19:55:41 +00:00
* WorldOfP2P
2018-07-27 14:04:11 +00:00
* x-ite.me
2017-05-04 19:55:41 +00:00
* x264
2018-03-23 17:47:47 +00:00
* xBytesV2
2017-05-04 19:55:41 +00:00
* XSpeeds
* Xthor
* ExoticaZ (Your Exotic Torrents)
2017-07-06 18:37:29 +00:00
* Zamunda.net
* Zelka.org
2017-05-04 19:55:41 +00:00
Trackers marked with [![(invite needed)][inviteneeded]](#) have no active maintainer and are missing features or are broken. If you have an invite for them please send it to kaso1717 -at- gmail.com to get them fixed/improved.
2018-04-07 16:48:13 +00:00
### Aggregate indexers
A special "all" indexer is available at `/api/v2.0/indexers/all/results/torznab/api`.
It will query all configured indexers and return the combined results.
To get all Jackett indexers including their capabilities you can use `t=indexers` on the all indexer. To get only configured/unconfigured indexers you can also add `configured=true/false` as query parameter.
2017-05-04 19:55:41 +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.
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".
2017-05-04 19:55:41 +00:00
## Installation on Linux
2018-06-05 05:24:05 +00:00
1. Install [Mono 5.8](http://www.mono-project.com/download/#download-lin) or better (using the latest stable release is recommended)
2017-05-04 19:55:41 +00:00
* Follow the instructions on the mono website and install the `mono-devel` and the `ca-certificates-mono` packages.
* On Red Hat/CentOS/openSUSE/Fedora the `mono-locale-extras` package is also required.
2. Install libcurl:
* Debian/Ubunutu: `apt-get install libcurl4-openssl-dev`
* Redhat/Fedora: `yum install libcurl-devel`
* 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 --debug 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/)
2017-09-17 13:05:42 +00:00
If you want to run it with a user without a /home directory you need to add `Environment=XDG_CONFIG_HOME=/path/to/folder` to your systemd file, this folder will be used to store your config files.
2018-05-21 13:51:07 +00:00
Mono must be compiled with the Roslyn compiler (default), using MCS will cause "An error has occurred." errors (See https://github.com/Jackett/Jackett/issues/2704).
2018-05-21 10:24:39 +00:00
## Installation on macOS
### Prerequisites
2018-07-06 11:04:31 +00:00
Install [Mono 5.8](http://www.mono-project.com/download/#download-mac) or better (using the latest pkg installer is recommended).
* Setup ssl support by running `curl -sS https://curl.haxx.se/ca/cacert.pem | cert-sync --user /dev/stdin`
### Install as service
1. Download and extract the latest `Jackett.Binaries.Mono.tar.gz` release from the [releases page](https://github.com/Jackett/Jackett/releases).
2. Open the extracted folder and double-click on `install_service_macos`.
3. If the installation was a success, you can close the Terminal window.
2018-01-29 18:38:57 +00:00
The service will start on each logon. You can always stop it by running `launchctl unload ~/Library/LaunchAgents/org.user.Jackett.plist` from Terminal. You can start it again it using `launchctl load ~/Library/LaunchAgents/org.user.Jackett.plist`.
Logs are stored as usual under `~/.config/Jackett/log.txt`.
### Run without installing as a service
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 --debug JackettConsole.exe`.
2017-05-04 19:55:41 +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)
## Installation on Synology
2017-08-05 00:46:03 +00:00
Jackett is available as beta package from [SynoCommunity](https://synocommunity.com/)
2017-05-04 19:55:41 +00:00
## Running Jackett behind a reverse proxy
When running jackett behind a reverse proxy make sure that the original hostname of the request is passed to Jackett. If HTTPS is used also set the X-Forwarded-Proto header to "https". Don't forget to adjust the "Base Path Override" Jackett option accordingly.
Example config for apache:
```
<Location /jackett>
ProxyPreserveHost On
RequestHeader set X-Forwarded-Proto expr=%{REQUEST_SCHEME}
ProxyPass http://127.0.0.1:9117
ProxyPassReverse http://127.0.0.1:9117
</Location>
```
Example config for nginx:
```
location /jackett {
proxy_pass http://127.0.0.1:9117;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Forwarded-Host $host;
proxy_redirect off;
}
```
2017-05-04 19:55:41 +00:00
## Troubleshooting
* __Command line switches__
You can pass various options when running via the command line, see --help for details.
2017-09-08 15:47:50 +00:00
* __Error "The underlying connection was closed: Could not establish trust relationship for the SSL/TLS secure channel."__
2017-05-04 19:55:41 +00:00
2017-09-08 15:47:50 +00:00
This is often caused by missing CA certificates.
2017-05-19 15:32:17 +00:00
Try reimporting the certificates in this case:
2017-09-08 15:47:50 +00:00
- On Linux (as user root): `wget -O - https://curl.haxx.se/ca/cacert.pem | cert-sync /dev/stdin`
- On macOS: `curl -sS https://curl.haxx.se/ca/cacert.pem | cert-sync --user /dev/stdin`
2017-05-19 15:33:04 +00:00
2018-03-25 03:03:01 +00:00
* __Enable enhanced logging__
2017-05-04 19:55:41 +00:00
2018-03-25 03:03:01 +00:00
You can get *enhanced* logging with the command line switches `-t -l` or by enabling `Enhanced logging` via the web interface (followed by clicking on the `Apply Server Settings` button).
2017-05-04 19:55:41 +00:00
Please post logs if you are unable to resolve your issue with these switches ensuring to remove your username/password/cookies.
The logfiles (log.txt/updater.txt) are stored in `%ProgramData%\Jackett` on Windows and `~/.config/Jackett/` on Linux/macOS.
2017-05-04 19:55:41 +00:00
## Configuring OMDb
This feature is used as a fallback to get the movie/series title if only the IMDB ID is provided in the request.
To use it, please just request a free API key on [OMDb](http://www.omdbapi.com/apikey.aspx) (1,000 daily requests limit) and paste the key in Jackett
2017-05-04 19:55:41 +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.
## Contributing
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 2017 when making code changes in this project. You can download the community version for free [here](https://www.visualstudio.com/downloads/).
2017-05-04 19:55:41 +00:00
2018-03-29 17:17:27 +00:00
## Building from source
### Windows
2018-06-27 12:11:57 +00:00
* Install the .NET Core [SDK](https://www.microsoft.com/net/download/windows)
* Open the Jackett solution in Visual Studio 2017 (version 15.7 or above)
* Right click on the Jackett solution and click 'Rebuild Solution' to restore nuget packages
2018-03-29 17:17:27 +00:00
* Select Jackett.Console as startup project
* Build/Start the project
### OSX
NOTE: msbuild is included in the mono release.
* Install Homebrew https://brew.sh
* open terminal
* brew install nuget mono
* git clone https://github.com/Jackett/Jackett.git
* cd Jackett/src
* nuget restore Jackett.sln
NOTE: if you get the error "NU1102: Unable to find package Microsoft.AspNetCore with version (>= 2.1.2)" while restoring packages, you'll need to install it manually.https://www.microsoft.com/net/download/thank-you/dotnet-sdk-2.1.302-macos-x64-installer then delete the entire project directory and restart from a new clone
* msbuild Jackett.Console/Jackett.Console.csproj /t:Build /p:Configuration=Debug
* curl -sS https://curl.haxx.se/ca/cacert.pem | cert-sync --user /dev/stdin
* mono Jackett.Console/bin/Debug/JackettConsole.exe
2018-03-29 17:17:27 +00:00
### Linux
```bash
sudo apt install mono-complete nuget msbuild # install build tools (debian/ubuntu)
git clone https://github.com/Jackett/Jackett.git
cd Jackett/src
nuget restore Jackett.sln # prepare dependencies
msbuild Jackett.Console/Jackett.Console.csproj /t:Build /p:Configuration=Debug # compile
mono Jackett.Console/bin/Debug/JackettConsole.exe # run jackett
```
2017-05-04 19:55:41 +00:00
## Screenshots
![screenshot](https://i.imgur.com/0d1nl7g.png "screenshot")
[inviteneeded]: https://raw.githubusercontent.com/Jackett/Jackett/master/.github/label-inviteneeded.png