mirror/Jackett

Fork 0

mirror of https://github.com/Jackett/Jackett synced 2024-12-22 07:43:13 +00:00

Garfield69 44828b75e0 Update README.md

2024-12-17 09:14:08 +13:00

35 KiB

Raw Blame History

Jackett

Our server is no longer maintained. If you have a problem, request, or question then please open a new issue here.

This project is a new fork and is recruiting development help. If you can help out please contact us.

Please see our troubleshooting and contributing guidelines before submitting any issues or pull requests

Jackett works as a proxy server: it translates queries from apps (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious, NZBHydra2 etc.) into tracker-site-specific http queries, parses the html or json response, and 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.

Developer note:

The software implements the Torznab (with hybrid nZEDb/Newznab category numbering) and TorrentPotato APIs.

A third-party Golang SDK for Jackett is available from webtor-io/go-jackett

Supported Systems

Windows 10 Version 1607+ or greater supported operating systems here
Linux supported operating systems here
macOS 12.0+ (Monterey) or greater supported operating systems here

Supported Trackers

Supported Public Trackers

ØMagnet
1337x
52BT
ACG.RIP
Anidex
AniLibria
Anime Tosho
AniRena
AniSource
AudioBook Bay (ABB)
Badass Torrents
Bangumi Moe
BigFANGroup
BitRu
BitSearch
BlueRoms
BT.etree
BTdirectory (BT目录)
BTMET
BTSOW
Byrutor
Cinecalidad
cpasbien
cpasbienClone
CrackingPatching
DivxTotal
dmhy
DonTorrent
E-Hentai
EBook Bay (EBB)
Elitetorrent.wf
EpubLibre
EXT Torrents
ExtraTorrent.st
EZTV
Frozen Layer
GamesTorrents
GkTorrent
GloDLS
GTorrent.pro
Idope
ilCorSaRoNeRo
Internet Archive (archive.org)
Isohunt2
iTorrent
JAV-Torrent
kickasstorrents.to
kickasstorrents.ws
Knaben
LePorno.info
Libronube
LimeTorrents
LinuxTracker
Mac Torrents Download
Magnet Cat
MegaPeer
MejorTorrent
Mikan
MixTapeTorrent
MoviesDVDR
MyPornClub
Myporno
Newstudio
Nipponsei
NNTT
NoNaMe Club (NNM-Club)
Nyaa.si
NyaaPantsu
OneJAV
OxTorrent
OxTorrent-vip
OpenSharing
ParnuXi
PC-torrent
PornoTorrent
PornRips
Postman
ProPorn
Rapidzona
RinTorNeT
RuTor
RuTracker.RU
Seedoff
Sexy-Pics
Shana Project
ShowRSS
SimpleAnime
Solid Torrents
sosulki
SubsPlease
sukebei.Nyaa.si
The Pirate Bay (TPB)
TheRARBG
Tokyo Tosho
Torlock
Torrent Downloads
Torrent Oyun indir
Torrent[CORE]
torrent.by
torrent-pirat
Torrent9
Torrent9-tel
TorrentFunk
TorrentDownload
TorrentKitty
TorrentProject2
TorrentQQ (토렌트큐큐)
Torrents.csv
TorrentSir (토렌트썰)
TorrentView (토렌트뷰)
Torrentz2nz
TrahT
truPornolabs
U3C3
UnionDHT
VSTHouse
VST Torrentz
VSTorrent
Wolfmax4K
xxxAdultTorrent
XXXClub
xxxtor
YourBittorrent
YTS.ag
zetorrents

Supported Semi-Private Trackers

AniDUB
AnimeLayer
ArenaBG
Best-Torrents [PAY2DL]
BitMagnet (Local DHT) [site]
BookTracker
BootyTape
Catorrent
comicat
Deildu
Devil-Torrents
DreamingTree
DXP (Deaf Experts)
Electro-Torrent
EniaHD
Erai-Raws
Ex-torrenty
ExKinoRay
ExtremlymTorrents
File-Tracker
Gay-Torrents.net
Genesis-Movement
HD-CzTorrent
HDGalaKtik
HellTorrents
HunTorrent
Il CorSaRo Blu
ilDraGoNeRo
Kinorun
Kinozal
LostFilm.tv
Magnetico (Local DHT) [site]
Marine Tracker
Masters-TB
Mazepa
Metal Tracker
MioBT
MIRcrew
MuseBootlegs (MB)
MVGroup Forum
MVGroup Main
NetHD (VietTorrent)
Newstudio (login)
NoNaMe Club (NNM-Club) (login)
Polskie-Torrenty
PornoLab
PussyTorrents
Rainbow Tracker
RGFootball
RinTor
RiperAM
RockBox
RUDUB (ex-BaibaKoTV)
Rustorka
RuTracker.org
seleZen
Sharewood
SkTorrent
SkTorrent-org
themixingbowl (TMB)
Toloka
TorrentMasters
Torrents-Local
TribalMixes
Union Fansub
UniOtaku
ViDEOTEKA
ZOMB
Ztracker

Supported Private Trackers

0day.kiev
1ptbar
2 Fast 4 You
3ChangTrai (3CT)
3D Torrents (3DT)
4thD (4th Dimension)
52PT
720pier
Abnormal
ABtorrents (ABT + RNS)
AcrossTheTasman
Aftershock
AGSVPT (Artic Global Seed Vault)
Aidoru!Online
Aither
AlphaRatio (AR)
AmigosShareClub
AnimeBytes (AB)
AnimeLovers
AnimeTorrents (AnT)
AnimeTorrents.ro (Anime Torrents Romania)
AnimeWorld
Anthelion
Araba Fenice (Phoenix)
ArabP2P
ArabTorrents
AsianCinema
AsianDVDClub
Audiences
AudioNews (AN)
Aussierul.es
AvistaZ (AsiaTorrents)
Azusa (梓喵)
Back-ups
BakaBT
Beload
Best-Core
BeyondHD (BHD)
Bibliotik
Bit-Bázis
BIT-HDTV
Bitded
Bithorlo (BHO)
BitHUmen
Bitpalace
BitPorn
Bitspyder
BitTorrentFiles
BiTTuRK
BJ-Share (BJ)
BlueBird
BlurayTracker
Blutopia (BLU)
Borgzelle
Boxing Torrents
Brasil Tracker
BroadcasTheNet (BTN)
BrokenStones
BTArg
BTNext (BTNT)
BTSCHOOL
BWTorrents
BYRBT
CapybaraBR
Carp-Hunter
Carpathians
CarPT
Cathode-Ray.Tube (CRT)
CD File
CeskeForum
CGPeers
CHDBits
ChileBT
CineClassics
Cinemageddon
CinemaMovieS_ZT
Cinematik
CinemaZ (EuTorrents)
Classix
Coastal-Crew
ConCen
Concertos
CrabPT (蟹黄堡)
CrazySpirits
CrnaBerza
cyanbug (大青虫)
Dajiao (打胶)
DANISH BYTES
Dark-Shadow
Das Unerwartete (D-U)
DataScene (DS)
DesiTorrents
Diablo Torrent
DICMusic
DigitalCore
DimeADozen (EzTorrent)
DiscFan
DivTeam
DocsPedia
Dream Tracker
Drugari
Ebooks-Shares
Empornium (EMP)
Enthralled
eShareNet
eStone (BigTorrent)
Exitorrent.org
ExoticaZ (YourExotic)
ExtremeBits
F1Carreras
FANO.IN
Fantastiko
Fappaizuri
FearNoPeer
Femdomcult
FileList (FL)
FinElite (FE)
FinVip
Flux-Zone
Free Farm (自由农场)
FSM
FunFile (FF)
FunkyTorrents (FT)
FutureTorrent
Fuzer (FZ)
Gay-Torrents.org
GAYtorrent.ru
GazelleGames (GGn)
Generation-Free
GigaTorrents
GimmePeers (formerly ILT)
GiroTorrent
GreatPosterWall (GPW)
HaiDan
Hǎitáng (海棠PT)
HappyFappy
Hares Club (白兔俱乐部)
Hawke-uno
HD Dolby
HD Zero
HD-Club
HD-Forever (HDF)
HD-Olimpo
HD-Only (HDO)
HD-Space (HDS)
HD-Torrents (HDT)
HD-UNiT3D
HD4FANS
HDArea (HDA)
HDAtmos
HDBits
HDCiTY (HDC)
HDClone
HDFans
HDHome (HDBigger)
HDKylin (麒麟)
HDPT (明教)
HDRoute
HDSky
HDT-LaFenice
HDtime
HDTorrents.it [PAY2DL]
HDTurk
HDU
HDVIDEO
Hebits
HellasHut
HHanClub
HHD
HomePornTorrents (HPT)
House of Devil
HUDBT (蝴蝶)
iAnon
ICC2022 (冰淇淋)
ilolicon PT
ImmortalSeed (iS)
Immortuos
Indietorrents
INFINITY
Infire
Insane Tracker
IPTorrents (IPT)
IrishTV
ItaTorrents
JME-REUNIT3D
JoyHD
JPopsuki
JPTV
KamePT
Karagarga
Keep Friends
Kelu
Korsar
KrazyZone
Kufei (库非)
Kufirc
Last Digital Underground (LDU)
LastFiles
LaidBackManor
Lat-Team
Le Saloon
Le-Cinephile
LearnBits
LearnFlakes
Leech24
LemonHD
Lesbians4u
Libble
LibraNet (LN)
LinkoManija
Locadora
LosslessClub
LST
LustHive
M-Team TP (MTTP)
MaDs Revolution
Majomparádé (TurkDepo)
Making Off
Mansão dos Animes (MDAN)
Malayabits
MegamixTracker
MeseVilág (Fairytale World)
MetalGuru
Milkie
MMA-Torrents
MNV (Max-New-Vision)
MOJBLiNK
MonikaDesign (MDU)
MoreThanTV (MTV)
MouseBits
MyAnonamouse (MAM)
MySpleen
NCore
Nebulance (NBL) (TransmiTheNet)
NewHeaven (TorrentHeavenResurrection)
NicePT
NorBits
Ntelogo
Nusanta(RA.RE)
OKPT
Old Greek Tracker
Old Toons World
OpenCD
Orpheus
OnlyEncodes+
OshenPT
Ostwiki
OurBits (HDPter)
P2PBG
Panda
Party-Tracker
PassThePopcorn (PTP)
Peeratiko
Peers.FM
PigNetwork (猪猪网)
PixelCove (Ultimate Gamer)
PiXELHD (PxHD)
Polish Torrent (PTT)
PolishTracker
Pornbay
Portugas
Pretome
PrivateHD (PHD)
PrivateSilverScreen (PSS)
ProAudioTorrents (PAT)
PT GTK
PT分享站 (itzmx)
PTCafe (咖啡)
PTChina (铂金学院)
PTerClub (PT之友俱乐部)
PTFans
PTFiles (PTF)
PThome
PTSBAO (烧包)
PTtime
PTVicomo
Punk's Horror Tracker
PuntoTorrent
PuTao (葡萄)
PWTorrents (PWT)
Qingwa (青蛙)
R3V WTF!
Racing4Everyone (R4E)
RacingForMe (RFM)
RareShare2
Red Leaves (红叶)
Red Star Torrent (RST)
Redacted (PassTheHeadphones)
ReelFlix
Resurrect The Net
RetroFlix
RevolutionTT
RocketHD
Romanian Metal Torrents (RMT)
RoTorrent
Rousi
SATClubbing
SceneHD
SceneRush
SceneTime
Secret Cinema
SeedFile
seedpool
SFP (Share Friends Projekt)
Shareisland
Shazbat
SiamBIT
SnowPT (SSPT)
SoulVoice (聆音Club)
SpeedApp (SceneFZ, XtreMeZone / MYXZ, ICE Torrent)
SpeedCD
Speedmaster HD
Spirit of Revolution
SportsCult
SpringSunday
SugoiMusic
Superbits (SBS)
Swarmazon
Tapochek
Tasmanit
Team CT Game (TCTG)
TeamHD
TeamOS
TEKNO3D
teracod (Movie Zone)
TGay
The Crazy Ones
The Falling Angels (TFA)
The Geeks
The New Retro
The Occult
The Old School
The Paradiese
The Place
The Shinning (TsH)
The Show
The Vault
The-New-Fun
TheEmpire (TE)
TheLeachZone (TLZ)
ThePiratedShip
TJUPT (北洋园PT)
TLFBits
TmGHuB
Toca Share
Tormac
Tornado
Torrent Heaven (Dutch)
Torrent Network (TN)
Torrent Sector Crew (TSC)
Torrent Trader
Torrent-Explosiv
Torrent-Syndikat
TOrrent-tuRK (TORK)
Torrent.LT
TorrentBD
TorrentBytes (TBy)
TorrentCCF (TCCF)
TorrentDay (TD)
TorrentDD
Torrenteros (TTR)
TorrentHR
Torrenting (TT)
Torrentland
TorrentLeech (TL)
TorrentLeech.pl
TorrentSeeds (TS)
ToTheGlory (TTG)
TrackerMK
TranceTraffic
Trellas (Magico)
TreZzoR
TurkSeed
TurkTorrent (TT)
TV Chaos UK (TVCUK)
TVstore
U2 (U2分享園@動漫花園)
UBits
UHDBits
UltraHD
UnionGang
UnlimitZ
upload.cx
Upscale Vault
UTOPIA
Vault network
WDT (Wrestling Desires Torrents / Ultimate Wrestling Torrents)
White Angel
WinterSakura
World-In-HD
World-of-Tomorrow
Wukong (悟空问道)
x-ite.me (XM)
Xider-Torrent
XSpeeds (XS)
Xthor
xTorrenty
XtremeBytes
XWT-Classics
XWTorrents (XWT)
YggTorrent (YGG)
YOiNKED
Zamunda.net
Zelka.org
ZmPT (织梦)
ZonaQ

Trackers marked with have no active maintainer and may be broken or missing features. If you have an invite please send it to jacketttest [at] gmail [dot] com or garfieldsixtynine [at] gmail [dot] com get them fixed/improved.

Jackett Torznab query syntax

Jackett accepts Torznab queries following the specifications described in the Torznab document. For example, .../api/v2.0/indexers/<aJackettIndexerName>/results/torznab/api?apikey=<yourJackettApiKey>&t=caps would return the capabilities of the indexer, and .../api/v2.0/indexers/<aJackettIndexerName>/results/torznab/api?apikey=<yourJackettApiKey>&t=search&q=keywords would perform a free text search on that indexer.

Search modes and parameters

A list of supported API search modes and parameters:

t=search:
   params  : q
t=tvsearch:
   params  : q, season, ep, imdbid, tvdbid, rid, tmdbid, tvmazeid, traktid, doubanid, year, genre
t=movie:
   params  : q, imdbid, tmdbid, traktid, doubanid, year, genre
t=music:
   params  : q, album, artist, label, track, year, genre
t=book:
   params  : q, title, author, publisher, year, genre

Examples:

.../api?apikey=APIKEY&t=search&cat=1,3&q=Show+Title+S01E02

.../api?apikey=APIKEY&t=tvsearch&cat=1,3&q=Show+Title&season=1&ep=2
.../api?apikey=APIKEY&t=tvsearch&cat=1,3&genre=comedy&season=2023&ep=02/13

.../api?apikey=APIKEY&t=movie&cat=2&q=Movie+Title&year=2023
.../api?apikey=APIKEY&t=movie&cat=2&imdbid=tt1234567

.../api?apikey=APIKEY&t=music&cat=4&album=Title&artist=Name

.../api?apikey=APIKEY&t=book&cat=5,6&genre=horror&publisher=Stuff

Filter indexers

A special "filter" indexer is available at .../api/v2.0/indexers/<filter>/results/torznab It will query the configured indexers that match the <filter> expression criteria and return the combined results as "all".

Supported filters

Filter	Condition
`type:<type>`	where the indexer type is equal to `<type>`
`tag:<tag>`	where the indexer tags contain `<tag>`
`lang:<tag>`	where the indexer language start with `<lang>`
`test:{passed\|failed}`	where the last indexer test performed `passed` or `failed`
`status:{healthy\|failing\|unknown}`	where the indexer state is `healthy` (successfully operates in the last minutes), `failing` (generates errors in the recent call) or `unknown` (unused for a while)

Supported operators

Operator	Condition
`!<expr>`	where not `<expr>`
`<expr1>+<expr2>[+<expr3>...]`	where `<expr1>` and `<expr2>` [and `<expr3>`...]
`<expr1>,<expr2>[,<expr3>...]`	where `<expr1>` or `<expr2>` [or `<expr3>`...]

Example 1: The "filter" indexer at .../api/v2.0/indexers/tag:group1,!type:private+lang:en/results/torznab will query all the configured indexers tagged with group1 or all the indexers not private and with en language (en-en,en-us,...)

Example 2: The "filter" indexer at /api/v2.0/indexers/!status:failing,test:passed will query all the configured indexers not failing or which passed its last test.

Aggregate indexers

A special "all" indexer is available at /api/v2.0/indexers/all/results/torznab. It will query all configured indexers and return the combined results.

If your client supports multiple feeds it's recommended to add each indexer directly instead of using the "all" indexer. Using the "all" indexer has no advantages (besides reduced management overhead), the only disadvantages:

you lose control over indexer specific settings (categories, search modes, etc.)
mixing search modes (IMDB, query, etc.) might cause low-quality results
indexer specific categories (>= 100000) can't be used.
slow indexers will slow down the overall result
total results are limited to 1000

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 a query parameter.

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:

Check if you need any .NET prerequisites installed, see https://docs.microsoft.com/en-us/dotnet/core/install/windows?tabs=net80#dependencies
Download the latest version of the Windows installer, "Jackett.Installer.Windows.exe" from the releases page.
When prompted if you would like this app to make changes to your computer, select "yes".
If you would like to install Jackett as a Windows Service, make sure the "Install as Windows Service" checkbox is filled.
Once the installation has finished, check the "Launch Jackett" box to get started.
Navigate your web browser to http://127.0.0.1:9117
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".

Installation on Linux (AMDx64)

On most operating systems all the required dependencies will already be present. In case they are not, you can refer to this page https://github.com/dotnet/core/blob/master/Documentation/linux-prereqs.md

Install as service

A) Command to download and install the latest package and run the Jackett service:

cd /opt && f=Jackett.Binaries.LinuxAMDx64.tar.gz && sudo wget -Nc https://github.com/Jackett/Jackett/releases/latest/download/"$f" && sudo tar -xzf "$f" && sudo rm -f "$f" && cd Jackett* && sudo chown $(whoami):$(id -g) -R "/opt/Jackett" && sudo ./install_service_systemd.sh && systemctl status jackett.service && cd - && echo -e "\nVisit http://127.0.0.1:9117"

B) Or manually:

Download and extract the latest Jackett.Binaries.LinuxAMDx64.tar.gz release from the releases page
To install Jackett as a service, open a Terminal, cd to the jackett folder, and run sudo ./install_service_systemd.sh You need root permissions to install the service. The service will start on each logon. You can always stop it by running systemctl stop jackett.service from Terminal. You can start it again using systemctl start jackett.service. Logs are stored as usual under ~/.config/Jackett/log.txt and also in journalctl -u jackett.service.

Run without installing as a service

Download and extract the latest Jackett.Binaries.LinuxAMDx64.tar.gz release from the releases page, open a Terminal, cd to the jackett folder, and run Jackett with the command ./jackett

home directory

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.

Installation on Linux (ARMv7 or above)

Install as service

Download and extract the latest Jackett.Binaries.LinuxARM32.tar.gz or Jackett.Binaries.LinuxARM64.tar.gz (32 bit is the most common on ARM) release from the releases page
To install Jackett as a service, open a Terminal, cd to the jackett folder, and run sudo ./install_service_systemd.sh You need root permissions to install the service. The service will start on each logon. You can always stop it by running systemctl stop jackett.service from Terminal. You can start it again using systemctl start jackett.service. Logs are stored as usual under ~/.config/Jackett/log.txt and also in journalctl -u jackett.service.

Run without installing as a service

Download and extract the latest Jackett.Binaries.LinuxARM32.tar.gz or Jackett.Binaries.LinuxARM64.tar.gz (32 bit is the most common on ARM) release from the releases page, open a Terminal, cd to the jackett folder and run Jackett with the command ./jackett

home directory

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.

Installation on Linux (ARMv6 or below)

Install Mono 5.8 or better (using the latest stable release is recommended)
- 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.
Install libcurl:
- Debian/Ubuntu: apt-get install libcurl4-openssl-dev
- Redhat/Fedora: yum install libcurl-devel
- For other distros see the Curl docs.
Download and extract the latest Jackett.Binaries.Mono.tar.gz release from the releases page and run Jackett using mono with the command mono --debug JackettConsole.exe.
(Optional) To install Jackett as a service, open the Terminal and run sudo ./install_service_systemd_mono.sh You need root permissions to install the service. The service will start on each logon. You can always stop it by running systemctl stop jackett.service from Terminal. You can start it again it using systemctl start jackett.service. Logs are stored as usual under ~/.config/Jackett/log.txt and also in journalctl -u jackett.service.

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.

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).

Installation on Linux via Ansible

On a CentOS/RedHat 7 system: jewflix.jackett

On an Ubuntu 16 system: chrisjohnson00.jackett

Uninstallation on Linux

wget https://raw.githubusercontent.com/Jackett/Jackett/master/uninstall_service_systemd.sh --quiet -O -|sudo bash

Installation on macOS

Prerequisites

macOS 12.0+ (Monterey) or greater

Install as service

Download and extract the latest Jackett.Binaries.macOS.tar.gz or Jackett.Binaries.macOSARM64.tar.gz release from the releases page.
Open the extracted folder and double-click on install_service_macos.
If the installation was a success, you can close the Terminal window.

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.macOS.tar.gz or Jackett.Binaries.macOSARM64.tar.gz release from the releases page and run Jackett with the command ./jackett.

Uninstallation on macOS

curl -sSL https://raw.githubusercontent.com/Jackett/Jackett/master/uninstall_jackett_macos| bash

Installation on Linux or macOS via Homebrew

Homebrew Formulae - Jackett

Installation using Docker

Detailed instructions are available at LinuxServer.io Jackett Docker. The Jackett Docker is highly recommended, especially if you are having Mono stability issues or having issues running Mono on your system e.g. QNAP, Synology. Thanks to LinuxServer.io

Installation on Alpine Linux

Detailed instructions are available at Jackett's Wiki.

Installation on Synology

Jackett is available as a beta package from SynoCommunity

Installation on OpenWrt

Detailed instructions are available at Jackett's Wiki.

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 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 $http_host;
	proxy_redirect off;
}

Search Cache

Jackett has an internal cache to increase search speed and reduce the number of requests to torrent sites. The default values should be good for most users. If you have problems, you can reduce the TTL value in the configuration or even disable the cache. Keep in mind that you can be banned by the sites if you make a lot of requests.

Cache TTL (seconds): (default 2100 / 35 minutes) It indicates how long the results can remain in the cache.
Cache max results per indexer: (default 1000) How many results are kept in the cache for each indexer? This limit is used to limit the use of RAM. If you make many requests and you have enough memory, increase this number.

Torznab cache

If you have enabled the Jackett internal cache, but have an indexer for which you would prefer to fetch fresh results (thus ignoring the internal cache) then add the &cache=false parameter to your torznab query.

Configuring FlareSolverr

Some indexers are protected by Cloudflare or similar services and Jackett is not able to solve the challenges. For these cases, FlareSolverr has been integrated into Jackett. This service is in charge of solving the challenges and configuring Jackett with the necessary cookies. Setting up this service is optional; most indexers don't need it.

Install FlareSolverr service (following their instructions)
Configure FlareSolverr API URL in Jackett. For example: http://172.17.0.2:8191
It is recommended to keep the default value in FlareSolverr Max Timeout (ms)

Configuring OMDb

This feature is used as a fallback (when using the aggregate Indexer) 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 (1,000 daily requests limit) and paste the key in Jackett

Command line switches

You can pass various options when running via the command line:

Command Line Switches

-i, --Install Install Jackett windows service (Must be admin)
-s, --Start Start the Jacket Windows service (Must be admin)
-k, --Stop Stop the Jacket Windows service (Must be admin)
-u, --Uninstall Uninstall Jackett windows service (Must be admin).
-r, --ReserveUrls (Re)Register windows port reservations (Required for listening on all interfaces).
-l, --Logging Log all requests/responses to Jackett
-t, --Tracing Enable tracing
-c, --UseClient Override web client selection. [automatic(Default)/httpclient/httpclient2]
-x, --ListenPublic Listen publicly
-z, --ListenPrivate Only allow local access
-p, --Port Web server port
-n, --IgnoreSslErrors [true/false] Ignores invalid SSL certificates
-d, --DataFolder Specify the location of the data folder (Must be an admin on Windows)
- e.g. --DataFolder="D:\Your Data\Jackett".
- Don't use this on Unix (mono) systems. On Unix just adjust the HOME directory of the user to the data folder or set the XDG_CONFIG_HOME environment variable.
--NoRestart Don't restart after the update
--PIDFile Specify the location of the PID file
--NoUpdates Disable automatic updates
--help Display this help screen.
--version Display version information.

Building from source

Windows

See our contributing guide.

OSX

# manually install osx dotnet via:
https://dotnet.microsoft.com/download?initial-os=macos
# then:
git clone https://github.com/Jackett/Jackett.git
cd Jackett/src

# dotnet core version
dotnet publish Jackett.Server -f net8.0 --self-contained -r osx-x64 -c Debug # takes care of everything
./Jackett.Server/bin/Debug/net8.0/osx-x64/jackett # run jackett

Linux

sudo apt install nuget msbuild dotnet-sdk-8.0 # install build tools (Debian/ubuntu)
git clone https://github.com/Jackett/Jackett.git
cd Jackett/src

# dotnet core version
dotnet publish Jackett.Server -f net8.0 --self-contained -r linux-x64 -c Debug # takes care of everything
./Jackett.Server/bin/Debug/net8.0/linux-x64/jackett # run jackett

35 KiB Raw Blame History

Jackett

Developer note:

Supported Systems

Supported Trackers

Jackett Torznab query syntax

Search modes and parameters

Filter indexers

Aggregate indexers

Installation on Windows

Installation on Linux (AMDx64)

Install as service

Run without installing as a service

home directory

Installation on Linux (ARMv7 or above)

Install as service

Run without installing as a service

home directory

Installation on Linux (ARMv6 or below)

Installation on Linux via Ansible

Uninstallation on Linux

Installation on macOS

Prerequisites

Install as service

Run without installing as a service

Uninstallation on macOS

Installation on Linux or macOS via Homebrew

Installation using Docker

Installation on Alpine Linux

Installation on Synology

Installation on OpenWrt

Running Jackett behind a reverse proxy

Search Cache

Torznab cache

Configuring FlareSolverr

Configuring OMDb

Command line switches

Building from source

Windows

OSX

Linux

Screenshots

35 KiB

Raw Blame History