Repository files navigation

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 pleasecontact us.

Please see ourtroubleshooting 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.

The software implements theTorznab (with hybridnZEDb/Newznabcategory numbering) andTorrentPotato APIs.

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

The currently supported version of Jackett is 0.22.+, which is compatible with the following OS:

• Windows 10 Version 1607+ or greatersupported operating systems here
• Linuxsupported operating systems here
• macOS 13.0+ (Ventura) or greatersupported operating systems here

Prior versions of Jackett are no longer supported.

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 accepts Torznab queries following the specifications described in theTorznab 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.

A list of supported API search modes and parameters:

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

Examples:

.../api?apikey=APIKEY&t=search&cat=100002,100003&q=Show+Title+S01E02.../api?apikey=APIKEY&t=tvsearch&cat=5000&q=Show+Title&season=1&ep=2.../api?apikey=APIKEY&t=tvsearch&cat=5040,5045&genre=comedy&season=2023&ep=02/13.../api?apikey=APIKEY&t=movie&cat=100001&q=Movie+Title&year=2023.../api?apikey=APIKEY&t=movie&cat=2000&imdbid=tt1234567.../api?apikey=APIKEY&t=music&cat=100004&album=Title&artist=Name.../api?apikey=APIKEY&t=book&cat=100005,100006&genre=horror&publisher=Stuff

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

Supported filters

Supported operators

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 withgroup1 or all the indexers not private and withen 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 notfailing or whichpassed its last test.

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 uset=indexers on the "all" indexer. To get only configured/unconfigured indexers you can also addconfigured=true/false as a query parameter.

We recommend you install Jackett as a Windows service using the suppliedWindows installer. You may also download thezipped version if you would like to configure everything manually.

To get started with using the installer for Jackett, follow the steps below:

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

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

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:

1. Download and extract the latestJackett.Binaries.LinuxAMDx64.tar.gz release from thereleases page
2. To install Jackett as a service, open a Terminal, cd to the jackett folder, and runsudo ./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 runningsystemctl stop jackett.service from Terminal. You can start it again usingsystemctl start jackett.service. Logs are stored as usual under~/.config/Jackett/log.txt and also injournalctl -u jackett.service.

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

If you want to run it with a user without a /home directory you need to addEnvironment=XDG_CONFIG_HOME=/path/to/folder to your systemd file, this folder will be used to store your config files.

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

1. Download and extract the latestJackett.Binaries.LinuxARM32.tar.gz orJackett.Binaries.LinuxARM64.tar.gz (32 bit is the most common on ARM) release from thereleases page
2. To install Jackett as a service, open a Terminal, cd to the jackett folder, and runsudo ./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 runningsystemctl stop jackett.service from Terminal. You can start it again usingsystemctl start jackett.service. Logs are stored as usual under~/.config/Jackett/log.txt and also injournalctl -u jackett.service.

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

If you want to run it with a user without a /home directory you need to addEnvironment=XDG_CONFIG_HOME=/path/to/folder to your systemd file, this folder will be used to store your config files.

1. InstallMono 5.8 or better (using the latest stable release is recommended)
   • Follow the instructions on the mono website and install themono-devel and theca-certificates-mono packages.
   • On Red Hat/CentOS/openSUSE/Fedora themono-locale-extras package is also required.
2. Install libcurl:
   • Debian/Ubuntu:apt-get install libcurl4-openssl-dev
   • Redhat/Fedora:yum install libcurl-devel
   • For other distros see theCurl docs.
3. Download and extract the latestJackett.Binaries.Mono.tar.gz release from thereleases page and run Jackett using mono with the commandmono --debug JackettConsole.exe.
4. (Optional) To install Jackett as a service, open the Terminal and runsudo ./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 runningsystemctl stop jackett.service from Terminal. You can start it again it usingsystemctl start jackett.service. Logs are stored as usual under~/.config/Jackett/log.txt and also injournalctl -u jackett.service.

If you want to run it with a user without a /home directory you need to addEnvironment=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#2704).

On a CentOS/RedHat 7 system:jewflix.jackett

On an Ubuntu 16 system:chrisjohnson00.jackett

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

macOS 13.0+ (Ventura) or greater

1. Download and extract the latestJackett.Binaries.macOS.tar.gz orJackett.Binaries.macOSARM64.tar.gz release from thereleases page.
2. Open the extracted folder and double-click oninstall_service_macos.
3. 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 runninglaunchctl unload ~/Library/LaunchAgents/org.user.Jackett.plist from Terminal. You can start it again it usinglaunchctl load ~/Library/LaunchAgents/org.user.Jackett.plist.Logs are stored as usual under~/.config/Jackett/log.txt.

Download and extract the latestJackett.Binaries.macOS.tar.gz orJackett.Binaries.macOSARM64.tar.gz release from thereleases page and run Jackett with the command./jackett.

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

Homebrew Formulae - Jackett

Detailed instructions are available atLinuxServer.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 toLinuxServer.io

Detailed instructions are available atJackett's Wiki.

Jackett is available as abeta package fromSynoCommunity

Detailed instructions are available atJackett's Wiki.

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;}

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

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.

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)
• ConfigureFlareSolverr API URL in Jackett. For example:http://172.17.0.2:8191
• It is recommended to keep the default value inFlareSolverr Max Timeout (ms)

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 onOMDb (1,000 daily requests limit) and paste the key in Jackett

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

See our contributing guide.

# manually install osx dotnet via:https://dotnet.microsoft.com/download?initial-os=macos# then:git clone https://github.com/Jackett/Jackett.gitcd Jackett/src# dotnet core versiondotnet 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

sudo apt install nuget msbuild dotnet-sdk-8.0# install build tools (Debian/ubuntu)git clone https://github.com/Jackett/Jackett.gitcd Jackett/src# dotnet core versiondotnet 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