Jackett


Table of Contents

1. Introduction
2. Supported Systems
3. Supported Trackers
4. Installation

• Windows Installation
• Linux Installation (AMD x64)
• Linux Installation (ARMv7 or above)
• Linux Installation (ARMv6 or below)
• macOS Installation
• Docker Installation
• Other Installation Methods

1. Uninstallation
2. Configuration

• Running Behind Reverse Proxy
• Search Cache
• Torznab Cache
• FlareSolverr Configuration
• OMDb Configuration

1. API Usage

• Torznab Query Syntax
• Search Modes and Parameters
• Filter Indexers
• Aggregate Indexers

1. Command Line Options
2. Building from Source
3. Troubleshooting
4. Contributing

Introduction

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:

• Acts as a bridge between your apps and torrent trackers
• Provides recent uploads (similar to RSS feeds)
• Performs searches across multiple trackers
• Returns results in a standardized format (Torznab/TorrentPotato)

Key Features:

• Single repository of maintained indexer scraping and translation logic
• Removes the burden of tracker integration from other applications
• Supports public, semi-private and private trackers
• Implements the Torznab and TorrentPotato APIs

Developer Information

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.

Supported Systems

The currently supported version of Jackett is 0.24.+, which is compatible with:

• Windows: Windows 10 Version 1607 or greater (full list)
• Linux: Various distributions (full list)
• macOS: macOS 13.0+ (Ventura) or greater (full list)

Prior versions of Jackett are no longer supported.

Supported Trackers

Note: Trackers marked with [![(invite needed)][inviteneeded]](#) 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.

Installation

Windows Installation

Method 1: Using the Installer (Recommended)

Prerequisites:

• Windows 10 Version 1607 or newer
• Administrator privileges
• .NET prerequisites (check here)

Installation Steps:

1. Download the latest version of the Windows installer

1. Run the Jackett.Installer.Windows.exe program

1. When prompted for permission to make changes to your computer, click "Yes"

1. During installation:

• Check "Install as Windows Service" if you want Jackett to start automatically with Windows
• Check "Launch Jackett" to open Jackett after installation completes

1. Click "Install" and wait for the installation to finish

1. Double-click the Jackett tray icon, or navigate your web browser to http://127.0.0.1:9117

1. You are now ready to begin adding trackers

Service Management:

• When installed as a service, the tray icon acts as a way to open, start, or stop Jackett
• If not installed as a service, Jackett will run its web server from the tray tool

Method 2: Manual Installation

1. Download the zipped version

1. Extract to your preferred location (e.g., C:ProgramDataJackett)

1. Run JackettConsole.exe to start Jackett

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

Linux Installation (AMD x64)

This section covers installation on most common Linux distributions including Ubuntu, Linux Mint, Debian, Fedora, and others.

Prerequisites:

• Most operating systems include all required dependencies
• If dependencies are missing, refer to .NET Required Packages

Method 1: One-Command Installation (Easiest)

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"

Method 2: Step-by-Step Installation

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

1. Set proper ownership:

   sudo chown -R $(whoami):$(id -g) /opt/Jackett

1. Install as a service:

   cd /opt/Jackett
   sudo ./install_service_systemd.sh

1. Check service status:

   systemctl status jackett.service

1. Navigate your web browser to http://127.0.0.1:9117

Running Without Installing as a Service

1. Download and extract the latest Jackett.Binaries.LinuxAMDx64.tar.gz release from the releases page

1. Open a Terminal and cd to the Jackett folder

1. Run Jackett with the command ./jackett

Service Management Commands

# 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

Home Directory Configuration

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.

Linux Installation (ARMv7 or above)

For modern ARM-based systems (Raspberry Pi, etc.)

Prerequisites:

• Most operating systems include all required dependencies
• If dependencies are missing, refer to .NET Required Packages

Installing as a Service

1. Download the appropriate release:

• For 32-bit ARM (most common): Jackett.Binaries.LinuxARM32.tar.gz
• For 64-bit ARM: Jackett.Binaries.LinuxARM64.tar.gz

   cd /opt
   wget -O - -o /dev/stderr https://github.com/Jackett/Jackett/releases/latest/download/Jackett.Binaries.LinuxARM32.tar.gz | sudo tar -xz

1. Install as a service:

   cd /opt/Jackett
   sudo ./install_service_systemd.sh

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

1. Download and extract the latest Jackett.Binaries.LinuxARM32.tar.gz or Jackett.Binaries.LinuxARM64.tar.gz release from the releases page

1. Open a Terminal and cd to the Jackett folder

1. Run Jackett with the command ./jackett

Linux Installation (ARMv6 or below)

For legacy ARM systems.

Prerequisites:

1. Install Mono 5.10 or newer (latest stable release recommended):

• Follow instructions on the Mono website
• Install mono-devel and ca-certificates-mono packages
• On Red Hat/CentOS/openSUSE/Fedora, also install mono-locale-extras

1. Install libcurl:

• Debian/Ubuntu: apt-get install libcurl4-openssl-dev
• Redhat/Fedora: yum install libcurl-devel
• For other distributions, see the Curl documentation

1. Download and extract the latest Jackett.Binaries.Mono.tar.gz from the releases page

1. Run Jackett using Mono:

   mono --debug JackettConsole.exe

1. (Optional) To install as a service:

   sudo ./install_service_systemd_mono.sh

Important Notes:

• Mono must be compiled with the Roslyn compiler (default)
• Using MCS will cause "An error has occurred" errors (see issue #2704)
• For users without a /home directory, add Environment=XDG_CONFIG_HOME=/path/to/folder to your systemd file

macOS Installation

Prerequisites:

• macOS 13.0+ (Ventura) or greater

Installing as a Service

1. Download the appropriate release:

• Intel (x86): Jackett.Binaries.macOS.tar.gz
• Apple silicon (ARM): Jackett.Binaries.macOSARM64.tar.gz

Get the latest release from the releases page

1. Extract the downloaded file

1. Open the extracted folder and double-click on install_service_macos

1. If installation is successful, close the Terminal window

1. 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.txt

Running Without Installing as a Service

1. Download and extract the latest Jackett.Binaries.macOS.tar.gz or Jackett.Binaries.macOSARM64.tar.gz release from the releases page

1. Open Terminal and navigate to the Jackett folder

1. Run Jackett with the command ./jackett

Docker Installation

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.

Other Installation Methods

Linux via Ansible

• CentOS/RedHat 7: jewflix.jackett
• Ubuntu 16: chrisjohnson00.jackett

Homebrew (macOS/Linux)

Install via Homebrew: Homebrew Formulae - Jackett

Synology

Jackett is available as a beta package from SynoCommunity

Alpine Linux

Detailed instructions available at Jackett's Wiki - Alpine Linux

OpenWrt

Detailed instructions available at Jackett's Wiki - OpenWrt

Uninstallation

Windows

• Use "Add or Remove Programs" in Windows Settings
• Or run the installer again and choose "Uninstall"

Linux

Run this command:

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

macOS

Run this command:

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

Configuration

Running Behind Reverse Proxy

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.

Apache Configuration Example

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

Nginx Configuration Example

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 suitable for most users.

Configuration Options:

• Cache TTL (seconds): Default is 2100 (35 minutes). This indicates how long results can remain in the cache.
• Cache max results per indexer: Default is 1000. This limits how many results are kept in cache for each indexer to control RAM usage.

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.

Torznab Cache

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

Configuring FlareSolverr

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:

1. Install FlareSolverr service following their installation instructions

1. Configure FlareSolverr in Jackett:

• Open Jackett settings
• Set FlareSolverr API URL (e.g., http://172.17.0.2:8191)
• It is recommended to keep the default value in FlareSolverr Max Timeout (ms)

Note: Setting up this service is optional. Most indexers do not require it.

Configuring OMDb

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:

1. Request a free API key from OMDb

• Free tier allows 1,000 daily requests

1. Paste the API key in Jackett settings

API Usage

Jackett Torznab Query Syntax

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

Search Modes and Parameters

Jackett supports the following search modes:

t=search (General Search)

Parameters: q (query string)

Example:

.../api?apikey=YOUR_API_KEY&t=search&cat=100002,100003&q=Show+Title+S01E02

t=tvsearch (TV Search)

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

t=movie (Movie Search)

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

t=music (Music Search)

Parameters: q, album, artist, label, track, year, genre

Example:

.../api?apikey=YOUR_API_KEY&t=music&cat=100004&album=Title&artist=Name

t=book (Book Search)

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.

Filter Indexers

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

Supported Filters

| Filter | Condition |
|--------|-----------|
| type: | Indexer type equals `` |
| tag: | Indexer tags contain `` |
| lang: | Indexer language starts with `` |
| 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 |

Supported Operators

| Operator | Condition |
|----------|-----------|
| ! | NOT `` |
| + | ` AND ` |
| , | ` OR ` |

Filter Examples

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

Aggregate Indexers

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.

Important Considerations

When to use the "all" indexer:

• Quick setup with fewer configuration steps
• Testing multiple indexers at once

Limitations of the "all" indexer:

• 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) cannot be used
• Slow indexers will slow down overall results
• Total results are limited to 1000

Recommendation: If your client supports multiple feeds, add each indexer directly instead of using the "all" indexer for better control and performance.

Getting Indexer Information

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

Command Line Switches

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

Windows Service Management

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

Configuration Options

• -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)
• Example: --DataFolder="D:Your DataJackett"
• Note: Do not use this on Unix (Mono) systems. Adjust the HOME directory or set XDG_CONFIG_HOME environment variable instead
• --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

Example Usage

# 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

Building from Source

Windows

See the contributing guide for detailed instructions.

macOS

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

Linux

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

Troubleshooting

Common Issues

Cannot Connect to 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:

• Instead of http://127.0.0.1:9117, try http://localhost:9117

Check firewall:

• Ensure port 9117 is not blocked by your firewall
• On Linux: sudo ufw allow 9117
• On Windows: Check Windows Defender Firewall settings

No Search Results

Test the indexer directly:

1. Go to Jackett dashboard
2. Click "Manual Search" on the indexer
3. Enter a test query
4. Check if results appear

Verify tracker status:

• Check if the tracker website is accessible in your browser
• Some trackers may be down or blocking your IP

Check indexer configuration:

• For private trackers, ensure your credentials are correct
• Try re-adding the indexer

Permission Denied Errors (Linux)

# Fix ownership of Jackett files
sudo chown -R $USER:$USER /opt/Jackett
sudo chown -R $USER:$USER ~/.config/Jackett

Service Won't Start (Linux)

# 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

Cloudflare Protection

If an indexer shows "Cloudflare protected" errors:

1. Install and configure FlareSolverr (see Configuring FlareSolverr)
2. Make sure FlareSolverr is running and accessible
3. Test the indexer again

Updates Failing

Manual update:

1. Download the latest release for your platform
2. Stop Jackett service
3. Extract new files over existing installation
4. Start Jackett service

Disable automatic updates:

./jackett --NoUpdates

Other Common Issues

See https://github.com/Jackett/Jackett/wiki/Troubleshooting

Getting Help

1. Check the GitHub Issues for similar problems
2. Read the Troubleshooting Guide
3. Open a new issue with:

• Your operating system and version
• Jackett version
• Error messages from logs
• Steps to reproduce the problem

Log Locations

Linux:

• ~/.config/Jackett/log.txt
• journalctl -u jackett.service

Windows:

• %ProgramData%Jackettlog.txt

macOS:

• ~/.config/Jackett/log.txt
• /Users/your-user-name/Library/Application Support/Jackett/log.txt

Contributing

This project is actively recruiting development help. If you can contribute code, please see:

• Contributing Guidelines
• Open Issues
• Contact the Team

Ways to Contribute:

• Report bugs and issues
• Suggest new features
• Add or fix indexer definitions
• Improve documentation
• Submit code contributions

Screenshots

!Jackett Dashboard

!Indexer Management

!Search Results

Quick Reference

| 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%Jackettlog.txt |
| Latest Release | GitHub Releases |
| Documentation | GitHub Wiki |
| Issues | GitHub Issues |

License and Credits

Jackett is an open-source project maintained by the community.

Links:

• GitHub Repository
• Issue Tracker
• Release Notes

[inviteneeded]: https://raw.githubusercontent.com/Jackett/Jackett/master/.github/label-inviteneeded.png