README.md
Jackett works as a proxy server that translates queries from applications (Sonarr, Radarr, SickRage, CouchPotato, Mylar3, Lidarr, DuckieTV, qBittorrent, Nefarious, NZBHydra2, etc.) into tracker-site-specific HTTP queries, parses the HTML or JSON response, and sends results back to the requesting software.
What Jackett does:
Key Features:
This project is recruiting development help. If you can help out please contact us.
For detailed troubleshooting and contributing guidelines, please see CONTRIBUTING.md
A third-party Golang SDK for Jackett is available from webtor-io/go-jackett
Note: The Discord server is no longer maintained. If you have a problem, request, or question, please open a new issue on GitHub.
The currently supported version of Jackett is 0.24.+, which is compatible with:
Prior versions of Jackett are no longer supported.
Note: 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 to help improve these indexers.
Prerequisites:
Installation Steps:
Download the latest version of the Windows installer
Run the Jackett.Installer.Windows.exe program
When prompted for permission to make changes to your computer, click "Yes"
During installation:
Click "Install" and wait for the installation to finish
Double-click the Jackett tray icon, or navigate your web browser to http://127.0.0.1:9117
You are now ready to begin adding trackers
Service Management:
Download the zipped version
Extract to your preferred location (e.g., C:\ProgramData\Jackett)
Run JackettConsole.exe to start Jackett
Navigate your web browser to http://127.0.0.1:9117
Running from Command Line:
You can run Jackett from the command line to see log messages. Use JackettConsole.exe (for Command Prompt), found in the Jackett data folder: e.g. %ProgramData%\Jackett. Ensure the server is not already running from the tray or service.
This section covers installation on most common Linux distributions including Ubuntu, Linux Mint, Debian, Fedora, and others.
Prerequisites:
Copy and paste this command into your terminal:
cd /opt && wget -O - -o /dev/stderr https://github.com/Jackett/Jackett/releases/latest/download/Jackett.Binaries.LinuxAMDx64.tar.gz | sudo tar -xz && 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"
Download and extract the latest release:
cd /opt
wget -O - -o /dev/stderr https://github.com/Jackett/Jackett/releases/latest/download/Jackett.Binaries.LinuxAMDx64.tar.gz | sudo tar -xz
Set proper ownership:
sudo chown -R $(whoami):$(id -g) /opt/Jackett
Install as a service:
cd /opt/Jackett
sudo ./install_service_systemd.sh
Check service status:
systemctl status jackett.service
Navigate your web browser to http://127.0.0.1:9117
Download and extract the latest Jackett.Binaries.LinuxAMDx64.tar.gz release from the releases page
Open a Terminal and cd to the Jackett folder
Run Jackett with the command ./jackett
# Start Jackett
systemctl start jackett.service
# Stop Jackett
systemctl stop jackett.service
# Restart Jackett
systemctl restart jackett.service
# Check status
systemctl status jackett.service
Logs Location: ~/.config/Jackett/log.txt
View Logs: journalctl -u jackett.service
If you want to run Jackett with a user without a /home directory, add this line to your systemd file:
Environment=XDG_CONFIG_HOME=/path/to/folder
This folder will be used to store configuration files.
For modern ARM-based systems (Raspberry Pi, etc.)
Prerequisites:
Download the appropriate release:
Jackett.Binaries.LinuxARM32.tar.gzJackett.Binaries.LinuxARM64.tar.gzcd /opt
wget -O - -o /dev/stderr https://github.com/Jackett/Jackett/releases/latest/download/Jackett.Binaries.LinuxARM32.tar.gz | sudo tar -xz
Install as a service:
cd /opt/Jackett
sudo ./install_service_systemd.sh
The service will start on each login. Manage it using:
# Start Jackett
systemctl start jackett.service
# Stop Jackett
systemctl stop jackett.service
# Restart Jackett
systemctl restart jackett.service
# Check status
systemctl status jackett.service
Download and extract the latest Jackett.Binaries.LinuxARM32.tar.gz or Jackett.Binaries.LinuxARM64.tar.gz release from the releases page
Open a Terminal and cd to the Jackett folder
Run Jackett with the command ./jackett
For legacy ARM systems.
Prerequisites:
Install Mono 5.10 or newer (latest stable release recommended):
mono-devel and ca-certificates-mono packagesmono-locale-extrasInstall libcurl:
apt-get install libcurl4-openssl-devyum install libcurl-develDownload and extract the latest Jackett.Binaries.Mono.tar.gz from the releases page
Run Jackett using Mono:
mono --debug JackettConsole.exe
(Optional) To install as a service:
sudo ./install_service_systemd_mono.sh
Important Notes:
/home directory, add Environment=XDG_CONFIG_HOME=/path/to/folder to your systemd filePrerequisites:
Download the appropriate release:
Jackett.Binaries.macOS.tar.gzJackett.Binaries.macOSARM64.tar.gzGet the latest release from the releases page
Extract the downloaded file
Open the extracted folder and double-click on install_service_macos
If installation is successful, close the Terminal window
Navigate your web browser to http://127.0.0.1:9117
Service Management:
The service will start on each login. You can control it using:
# Stop Jackett
launchctl unload ~/Library/LaunchAgents/org.user.Jackett.plist
# Start Jackett
launchctl load ~/Library/LaunchAgents/org.user.Jackett.plist
Logs Location:
~/.config/Jackett/log.txt/Users/your-user-name/Library/Application Support/Jackett/log.txtDownload and extract the latest Jackett.Binaries.macOS.tar.gz or Jackett.Binaries.macOSARM64.tar.gz release from the releases page
Open Terminal and navigate to the Jackett folder
Run Jackett with the command ./jackett
Docker installation is highly recommended, especially if you are experiencing Mono stability issues or having trouble running Mono on your system (e.g., QNAP, Synology).
Detailed instructions are available at LinuxServer.io Jackett Docker
Thanks to LinuxServer.io for maintaining the Docker image.
Install via Homebrew: Homebrew Formulae - Jackett
Jackett is available as a beta package from SynoCommunity
Detailed instructions available at Jackett's Wiki - Alpine Linux
Detailed instructions available at Jackett's Wiki - OpenWrt
Run this command:
wget https://raw.githubusercontent.com/Jackett/Jackett/master/uninstall_service_systemd.sh --quiet -O - | sudo bash
Run this command:
curl -sSL https://raw.githubusercontent.com/Jackett/Jackett/master/uninstall_jackett_macos | bash
When running Jackett behind a reverse proxy, ensure that the original hostname of the request is passed to Jackett. If HTTPS is used, also set the X-Forwarded-Proto header to "https".
Important: Adjust the "Base path override" in Jackett settings accordingly.
<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>
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 suitable for most users.
Configuration Options:
Note: If you make many requests and have sufficient memory, you can increase the maximum results. If you experience problems, you can reduce the TTL value or disable the cache. Be aware that making too many requests can result in being banned by tracker sites.
If you have enabled the Jackett internal cache but want to fetch fresh results for a specific query (ignoring the cache), add the &cache=false parameter to your Torznab query.
Example:
http://127.0.0.1:9117/api/v2.0/indexers/all/results/torznab/api?apikey=YOUR_API_KEY&t=search&q=query&cache=false
Some indexers are protected by Cloudflare or similar services, and Jackett cannot solve the challenges on its own. For these cases, FlareSolverr has been integrated into Jackett.
What is FlareSolverr: FlareSolverr is a proxy server that solves Cloudflare and other anti-bot challenges, then provides Jackett with the necessary cookies.
Setup Instructions:
Install FlareSolverr service following their installation instructions
Configure FlareSolverr in Jackett:
http://172.17.0.2:8191)Note: Setting up this service is optional. Most indexers do not require it.
This feature is used as a fallback when using the aggregate indexer to get the movie or series title if only the IMDB ID is provided in the request.
Setup Instructions:
Request a free API key from OMDb
Paste the API key in Jackett settings
Jackett accepts Torznab queries following the specifications described in the Torznab specification document.
Basic Query Structure:
http://127.0.0.1:9117/api/v2.0/indexers/<indexer-name>/results/torznab/api?apikey=<your-api-key>&t=<search-type>&<parameters>
Examples:
Get indexer capabilities:
http://127.0.0.1:9117/api/v2.0/indexers/1337x/results/torznab/api?apikey=YOUR_API_KEY&t=caps
Perform a free text search:
http://127.0.0.1:9117/api/v2.0/indexers/1337x/results/torznab/api?apikey=YOUR_API_KEY&t=search&q=ubuntu
Jackett supports the following search modes:
Parameters: q (query string)
Example:
.../api?apikey=YOUR_API_KEY&t=search&cat=100002,100003&q=Show+Title+S01E02
Parameters: q, season, ep, imdbid, tvdbid, rid, tmdbid, tvmazeid, traktid, doubanid, year, genre
Examples:
.../api?apikey=YOUR_API_KEY&t=tvsearch&cat=5000&q=Show+Title&season=1&ep=2
.../api?apikey=YOUR_API_KEY&t=tvsearch&cat=5040,5045&genre=comedy&season=2023&ep=02/13
Parameters: q, imdbid, tmdbid, traktid, doubanid, year, genre
Examples:
.../api?apikey=YOUR_API_KEY&t=movie&cat=100001&q=Movie+Title&year=2023
.../api?apikey=YOUR_API_KEY&t=movie&cat=2000&imdbid=tt1234567
Parameters: q, album, artist, label, track, year, genre
Example:
.../api?apikey=YOUR_API_KEY&t=music&cat=100004&album=Title&artist=Name
Parameters: q, title, author, publisher, year, genre
Example:
.../api?apikey=YOUR_API_KEY&t=book&cat=100005,100006&genre=horror&publisher=Stuff
Note: Most indexers will only support a subset of these search modes and parameters. Use t=caps to get a list of the actual modes and parameters supported by a specific indexer.
A special "filter" indexer is available at:
http://127.0.0.1:9117/api/v2.0/indexers/<filter>/results/torznab
It will query the configured indexers that match the filter expression criteria and return combined results as "all".
| Filter | Condition |
|---|---|
type:<type> | Indexer type equals <type> |
tag:<tag> | Indexer tags contain <tag> |
lang:<lang> | Indexer language starts with <lang> |
test:passed | Last indexer test passed |
test:failed | Last indexer test failed |
status:healthy | Indexer successfully operated in recent minutes |
status:failing | Indexer generated errors in recent calls |
status:unknown | Indexer unused for a while |
| Operator | Condition |
|---|---|
!<expr> | NOT <expr> |
<expr1>+<expr2> | <expr1> AND <expr2> |
<expr1>,<expr2> | <expr1> OR <expr2> |
Example 1: Query indexers tagged with "group1" OR all non-private indexers with English language:
.../api/v2.0/indexers/tag:group1,!type:private+lang:en/results/torznab
Example 2: Query indexers that are not failing OR that passed their last test:
.../api/v2.0/indexers/!status:failing,test:passed/results/torznab
A special "all" indexer is available at:
http://127.0.0.1:9117/api/v2.0/indexers/all/results/torznab
It will query all configured indexers and return combined results.
When to use the "all" indexer:
Limitations of the "all" indexer:
Recommendation: If your client supports multiple feeds, add each indexer directly instead of using the "all" indexer for better control and performance.
To get all Jackett indexers including their capabilities:
.../api/v2.0/indexers/all/results/torznab/api?apikey=YOUR_API_KEY&t=indexers
To filter by configuration status:
.../api/v2.0/indexers/all/results/torznab/api?apikey=YOUR_API_KEY&t=indexers&configured=true
.../api/v2.0/indexers/all/results/torznab/api?apikey=YOUR_API_KEY&t=indexers&configured=false
You can pass various options when running Jackett via the command line:
-i, --Install - Install Jackett Windows service (requires administrator)-s, --Start - Start the Jackett Windows service (requires administrator)-k, --Stop - Stop the Jackett Windows service (requires administrator)-u, --Uninstall - Uninstall Jackett Windows service (requires administrator)-r, --ReserveUrls - 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 (accessible from other devices)-z, --ListenPrivate - Only allow local access (default)-p, --Port - Specify web server port (default: 9117)-n, --IgnoreSslErrors - Ignore invalid SSL certificates: true or false-d, --DataFolder - Specify the location of the data folder (requires administrator on Windows)
--DataFolder="D:\Your Data\Jackett\"--NoRestart - Don't restart after update--PIDFile - Specify the location of the PID file--NoUpdates - Disable automatic updates--help - Display help screen--version - Display version information# Start Jackett on a custom port
./jackett --Port 9118
# Start with public access enabled
./jackett --ListenPublic
# Start with custom data folder (Windows)
JackettConsole.exe --DataFolder="D:\Jackett Data"
# Enable detailed logging
./jackett --Logging --Tracing
See the contributing guide for detailed instructions.
Prerequisites: Install .NET SDK manually from dotnet.microsoft.com
Build Steps:
# Clone the repository
git clone https://github.com/Jackett/Jackett.git
cd Jackett/src
# Build for .NET Core
dotnet publish Jackett.Server -f net9.0 --self-contained -r osx-x64 -c Debug
# Run Jackett
./Jackett.Server/bin/Debug/net9.0/osx-x64/jackett
Prerequisites:
# Install build tools (Debian/Ubuntu)
sudo apt install nuget msbuild dotnet-sdk-9.0
# For other distributions, install equivalent packages
Build Steps:
# Clone the repository
git clone https://github.com/Jackett/Jackett.git
cd Jackett/src
# Build for .NET Core
dotnet publish Jackett.Server -f net9.0 --self-contained -r linux-x64 -c Debug
# Run Jackett
./Jackett.Server/bin/Debug/net9.0/linux-x64/jackett
Check if Jackett is running:
# Linux
systemctl status jackett.service
# Windows
- Check the system tray for Jackett icon
- Check Services (services.msc) for "Jackett" service
Try alternative URL:
http://127.0.0.1:9117, try http://localhost:9117Check firewall:
sudo ufw allow 9117Test the indexer directly:
Verify tracker status:
Check indexer configuration:
# Fix ownership of Jackett files
sudo chown -R $USER:$USER /opt/Jackett
sudo chown -R $USER:$USER ~/.config/Jackett
# View recent error logs
journalctl -u jackett.service -n 50
# Reload systemd and restart
sudo systemctl daemon-reload
sudo systemctl restart jackett.service
# Check for errors
systemctl status jackett.service
If an indexer shows "Cloudflare protected" errors:
Manual update:
Disable automatic updates:
./jackett --NoUpdates
See https://github.com/Jackett/Jackett/wiki/Troubleshooting
Linux:
~/.config/Jackett/log.txtjournalctl -u jackett.serviceWindows:
%ProgramData%\Jackett\log.txtmacOS:
~/.config/Jackett/log.txt/Users/your-user-name/Library/Application Support/Jackett/log.txtThis project is actively recruiting development help. If you can contribute code, please see:
Ways to Contribute:
| Item | Value/Location |
|---|---|
| Default URL | http://127.0.0.1:9117 |
| Default Port | 9117 |
| Config (Linux) | ~/.config/Jackett/ |
| Config (Windows) | %ProgramData%\Jackett\ |
| Config (macOS) | ~/.config/Jackett/ or ~/Library/Application Support/Jackett/ |
| Logs (Linux) | ~/.config/Jackett/log.txt |
| Logs (Windows) | %ProgramData%\Jackett\log.txt |
| Latest Release | GitHub Releases |
| Documentation | GitHub Wiki |
| Issues | GitHub Issues |
Jackett is an open-source project maintained by the community.
Links: