Jackett¶

Description / name	Input element
Your domain name

Overview¶

Jackett is a free, open-source, self-hosted indexer proxy server that acts as an intermediary between torrent indexing applications like Sonarr, Radarr, and qBittorrent, and various torrent trackers.

Manual

Releases

Community

Saltbox Setup Process

Opting for another indexer manager?

Explore alternatives

Skip to Sonarr

Deployment¶

sb install jackett

Usage¶

Visit http://jackett.iYOUR_DOMAIN_NAMEi.

Basics¶

Settings¶

Disabling Auto Update¶

Under "Jackett Configuration":

Check "Disable auto update".
Check "External access".
Click "Apply server settings".
The page will now reload.

Adding Indexers to Sonarr/Radarr¶

Under "Configured Indexers":

Click "Add Indexer" to add your favorite indexers (i.e. torrent trackers).
When adding indexers into Sonarr/Radarr, you will need:
1. Indexer's Torznab Feed
  - Copy this by clicking on "Copy Torznab Feed" button next to the Indexer.
  - You will need to replace...
  - https with http
  - jackett.yourdomain.tld with jackett:9117
2. Jacket API Key

Next¶

Are you setting Saltbox up for the first time?

Continue to Sonarr

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
jackett_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like jackett_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like jackett_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsWebDNSTraefikThemeDockerDocker+Global Override Options

jackett_name

# Type: string
jackett_name: jackett

jackett_role_web_subdomain

# Type: string
jackett_role_web_subdomain: "{{ jackett_name }}"

jackett_role_web_domain

# Type: string
jackett_role_web_domain: "{{ user.domain }}"

jackett_role_web_port

# Type: string
jackett_role_web_port: "9117"

jackett_role_web_url

# Type: string
jackett_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='jackett') + '.' + lookup('role_var', '_web_domain', role='jackett')
                       if (lookup('role_var', '_web_subdomain', role='jackett') | length > 0)
                       else lookup('role_var', '_web_domain', role='jackett')) }}"

jackett_role_dns_record

# Type: string
jackett_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='jackett') }}"

jackett_role_dns_zone

# Type: string
jackett_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='jackett') }}"

jackett_role_dns_proxy

# Type: bool (true/false)
jackett_role_dns_proxy: "{{ dns_proxied }}"

jackett_role_traefik_sso_middleware

# Type: string
jackett_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

jackett_role_traefik_middleware_default

# Type: string
jackett_role_traefik_middleware_default: "{{ traefik_default_middleware
                                             + (',themepark-' + jackett_name
                                               if (lookup('role_var', '_themepark_enabled', role='jackett') and global_themepark_plugin_enabled)
                                               else '') }}"

jackett_role_traefik_middleware_custom

# Type: string
jackett_role_traefik_middleware_custom: ""

jackett_role_traefik_certresolver

# Type: string
jackett_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

jackett_role_traefik_enabled

# Type: bool (true/false)
jackett_role_traefik_enabled: true

jackett_role_traefik_api_enabled

# Type: bool (true/false)
jackett_role_traefik_api_enabled: true

jackett_role_traefik_api_endpoint

# Type: string
jackett_role_traefik_api_endpoint: "PathPrefix(`/api`) || PathPrefix(`/dl`)"

jackett_role_themepark_enabled

# Options can be found at https://github.com/themepark-dev/theme.park
# Type: bool (true/false)
jackett_role_themepark_enabled: false

jackett_role_themepark_app

# Type: string
jackett_role_themepark_app: "jackett"

jackett_role_themepark_theme

# Type: string
jackett_role_themepark_theme: "{{ global_themepark_theme }}"

jackett_role_themepark_domain

# Type: string
jackett_role_themepark_domain: "{{ global_themepark_domain }}"

jackett_role_themepark_addons

# Type: list
jackett_role_themepark_addons: []

Container

jackett_role_docker_container

# Type: string
jackett_role_docker_container: "{{ jackett_name }}"

Image

jackett_role_docker_image_pull

# Type: bool (true/false)
jackett_role_docker_image_pull: true

jackett_role_docker_image_repo

# Type: string
jackett_role_docker_image_repo: "ghcr.io/hotio/jackett"

jackett_role_docker_image_tag

# Type: string
jackett_role_docker_image_tag: "release"

jackett_role_docker_image

# Type: string
jackett_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='jackett') }}:{{ lookup('role_var', '_docker_image_tag', role='jackett') }}"

Envs

jackett_role_docker_envs_default

# Type: dict
jackett_role_docker_envs_default:
  PUID: "{{ uid }}"
  PGID: "{{ gid }}"
  UMASK: "002"
  TZ: "{{ tz }}"

jackett_role_docker_envs_custom

# Type: dict
jackett_role_docker_envs_custom: {}

Volumes

jackett_role_docker_volumes_default

# Type: list
jackett_role_docker_volumes_default:
  - "{{ jackett_role_paths_location }}:/config"

jackett_role_docker_volumes_custom

# Type: list
jackett_role_docker_volumes_custom: []

Labels

jackett_role_docker_labels_default

# Type: dict
jackett_role_docker_labels_default: {}

jackett_role_docker_labels_custom

# Type: dict
jackett_role_docker_labels_custom: {}

Hostname

jackett_role_docker_hostname

# Type: string
jackett_role_docker_hostname: "{{ jackett_name }}"

Networks

jackett_role_docker_networks_alias

# Type: string
jackett_role_docker_networks_alias: "{{ jackett_name }}"

jackett_role_docker_networks_default

# Type: list
jackett_role_docker_networks_default: []

jackett_role_docker_networks_custom

# Type: list
jackett_role_docker_networks_custom: []

Restart Policy

jackett_role_docker_restart_policy

# Type: string
jackett_role_docker_restart_policy: unless-stopped

State

jackett_role_docker_state

# Type: string
jackett_role_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

jackett_role_docker_blkio_weight

# Type: int
jackett_role_docker_blkio_weight:

jackett_role_docker_cpu_period

# Type: int
jackett_role_docker_cpu_period:

jackett_role_docker_cpu_quota

# Type: int
jackett_role_docker_cpu_quota:

jackett_role_docker_cpu_shares

# Type: int
jackett_role_docker_cpu_shares:

jackett_role_docker_cpus

# Type: string
jackett_role_docker_cpus:

jackett_role_docker_cpuset_cpus

# Type: string
jackett_role_docker_cpuset_cpus:

jackett_role_docker_cpuset_mems

# Type: string
jackett_role_docker_cpuset_mems:

jackett_role_docker_kernel_memory

# Type: string
jackett_role_docker_kernel_memory:

jackett_role_docker_memory

# Type: string
jackett_role_docker_memory:

jackett_role_docker_memory_reservation

# Type: string
jackett_role_docker_memory_reservation:

jackett_role_docker_memory_swap

# Type: string
jackett_role_docker_memory_swap:

jackett_role_docker_memory_swappiness

# Type: int
jackett_role_docker_memory_swappiness:

jackett_role_docker_shm_size

# Type: string
jackett_role_docker_shm_size:

Security & Devices

jackett_role_docker_cap_drop

# Type: list
jackett_role_docker_cap_drop:

jackett_role_docker_cgroupns_mode

# Type: string
jackett_role_docker_cgroupns_mode:

jackett_role_docker_device_cgroup_rules

# Type: list
jackett_role_docker_device_cgroup_rules:

jackett_role_docker_device_read_bps

# Type: list
jackett_role_docker_device_read_bps:

jackett_role_docker_device_read_iops

# Type: list
jackett_role_docker_device_read_iops:

jackett_role_docker_device_requests

# Type: list
jackett_role_docker_device_requests:

jackett_role_docker_device_write_bps

# Type: list
jackett_role_docker_device_write_bps:

jackett_role_docker_device_write_iops

# Type: list
jackett_role_docker_device_write_iops:

jackett_role_docker_devices

# Type: list
jackett_role_docker_devices:

jackett_role_docker_devices_default

# Type: string
jackett_role_docker_devices_default:

jackett_role_docker_groups

# Type: list
jackett_role_docker_groups:

jackett_role_docker_privileged

# Type: bool (true/false)
jackett_role_docker_privileged:

jackett_role_docker_security_opts

# Type: list
jackett_role_docker_security_opts:

jackett_role_docker_user

# Type: string
jackett_role_docker_user:

jackett_role_docker_userns_mode

# Type: string
jackett_role_docker_userns_mode:

Networking

jackett_role_docker_dns_opts

# Type: list
jackett_role_docker_dns_opts:

jackett_role_docker_dns_search_domains

# Type: list
jackett_role_docker_dns_search_domains:

jackett_role_docker_dns_servers

# Type: list
jackett_role_docker_dns_servers:

jackett_role_docker_domainname

# Type: string
jackett_role_docker_domainname:

jackett_role_docker_exposed_ports

# Type: list
jackett_role_docker_exposed_ports:

jackett_role_docker_hosts

# Type: dict
jackett_role_docker_hosts:

jackett_role_docker_hosts_use_common

# Type: bool (true/false)
jackett_role_docker_hosts_use_common:

jackett_role_docker_ipc_mode

# Type: string
jackett_role_docker_ipc_mode:

jackett_role_docker_links

# Type: list
jackett_role_docker_links:

jackett_role_docker_network_mode

# Type: string
jackett_role_docker_network_mode:

jackett_role_docker_pid_mode

# Type: string
jackett_role_docker_pid_mode:

jackett_role_docker_ports

# Type: list
jackett_role_docker_ports:

jackett_role_docker_uts

# Type: string
jackett_role_docker_uts:

Storage

jackett_role_docker_keep_volumes

# Type: bool (true/false)
jackett_role_docker_keep_volumes:

jackett_role_docker_mounts

# Type: list
jackett_role_docker_mounts:

jackett_role_docker_storage_opts

# Type: dict
jackett_role_docker_storage_opts:

jackett_role_docker_tmpfs

# Type: list
jackett_role_docker_tmpfs:

jackett_role_docker_volume_driver

# Type: string
jackett_role_docker_volume_driver:

jackett_role_docker_volumes_from

# Type: list
jackett_role_docker_volumes_from:

jackett_role_docker_volumes_global

# Type: bool (true/false)
jackett_role_docker_volumes_global:

jackett_role_docker_working_dir

# Type: string
jackett_role_docker_working_dir:

Monitoring & Lifecycle

jackett_role_docker_auto_remove

# Type: bool (true/false)
jackett_role_docker_auto_remove:

jackett_role_docker_cleanup

# Type: bool (true/false)
jackett_role_docker_cleanup:

jackett_role_docker_force_kill

# Type: string
jackett_role_docker_force_kill:

jackett_role_docker_healthcheck

# Type: dict
jackett_role_docker_healthcheck:

jackett_role_docker_healthy_wait_timeout

# Type: int
jackett_role_docker_healthy_wait_timeout:

jackett_role_docker_init

# Type: bool (true/false)
jackett_role_docker_init:

jackett_role_docker_kill_signal

# Type: string
jackett_role_docker_kill_signal:

jackett_role_docker_log_driver

# Type: string
jackett_role_docker_log_driver:

jackett_role_docker_log_options

# Type: dict
jackett_role_docker_log_options:

jackett_role_docker_oom_killer

# Type: bool (true/false)
jackett_role_docker_oom_killer:

jackett_role_docker_oom_score_adj

# Type: int
jackett_role_docker_oom_score_adj:

jackett_role_docker_output_logs

# Type: bool (true/false)
jackett_role_docker_output_logs:

jackett_role_docker_paused

# Type: bool (true/false)
jackett_role_docker_paused:

jackett_role_docker_recreate

# Type: bool (true/false)
jackett_role_docker_recreate:

jackett_role_docker_restart_retries

# Type: int
jackett_role_docker_restart_retries:

jackett_role_docker_stop_timeout

# Type: int
jackett_role_docker_stop_timeout:

Other Options

jackett_role_docker_capabilities

# Type: list
jackett_role_docker_capabilities:

jackett_role_docker_cgroup_parent

# Type: string
jackett_role_docker_cgroup_parent:

jackett_role_docker_commands

# Type: list
jackett_role_docker_commands:

jackett_role_docker_create_timeout

# Type: int
jackett_role_docker_create_timeout:

jackett_role_docker_entrypoint

# Type: string
jackett_role_docker_entrypoint:

jackett_role_docker_env_file

# Type: string
jackett_role_docker_env_file:

jackett_role_docker_labels_use_common

# Type: bool (true/false)
jackett_role_docker_labels_use_common:

jackett_role_docker_read_only

# Type: bool (true/false)
jackett_role_docker_read_only:

jackett_role_docker_runtime

# Type: string
jackett_role_docker_runtime:

jackett_role_docker_sysctls

# Type: list
jackett_role_docker_sysctls:

jackett_role_docker_ulimits

# Type: list
jackett_role_docker_ulimits:

jackett_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
jackett_role_autoheal_enabled: true

jackett_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
jackett_role_depends_on: ""

jackett_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
jackett_role_depends_on_delay: "0"

jackett_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
jackett_role_depends_on_healthchecks:

jackett_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
jackett_role_diun_enabled: true

jackett_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
jackett_role_dns_enabled: true

jackett_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
jackett_role_docker_controller: true

jackett_role_docker_image_repo

# Type: string
jackett_role_docker_image_repo:

jackett_role_docker_image_tag

# Type: string
jackett_role_docker_image_tag:

jackett_role_docker_volumes_download

# Type: bool (true/false)
jackett_role_docker_volumes_download:

jackett_role_themepark_addons

# Type: string
jackett_role_themepark_addons:

jackett_role_themepark_app

# Type: string
jackett_role_themepark_app:

jackett_role_themepark_enabled

# Type: bool (true/false)
jackett_role_themepark_enabled:

jackett_role_themepark_theme

# Type: string
jackett_role_themepark_theme:

jackett_role_traefik_api_endpoint

# Type: dict/omit
jackett_role_traefik_api_endpoint:

jackett_role_traefik_api_middleware

# Type: string
jackett_role_traefik_api_middleware:

jackett_role_traefik_api_middleware_http

# Type: string
jackett_role_traefik_api_middleware_http:

jackett_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
jackett_role_traefik_autodetect_enabled: false

jackett_role_traefik_certresolver

# Type: string
jackett_role_traefik_certresolver:

jackett_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
jackett_role_traefik_crowdsec_enabled: false

jackett_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
jackett_role_traefik_error_pages_enabled: false

jackett_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
jackett_role_traefik_gzip_enabled: false

jackett_role_traefik_middleware_http

# Type: string
jackett_role_traefik_middleware_http:

jackett_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
jackett_role_traefik_middleware_http_api_insecure:

jackett_role_traefik_middleware_http_insecure

# Type: bool (true/false)
jackett_role_traefik_middleware_http_insecure:

jackett_role_traefik_priority

# Type: string
jackett_role_traefik_priority:

jackett_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
jackett_role_traefik_robot_enabled: true

jackett_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
jackett_role_traefik_tailscale_enabled: false

jackett_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
jackett_role_traefik_wildcard_enabled: true

jackett_role_web_domain

# Type: string
jackett_role_web_domain:

jackett_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
jackett_role_web_fqdn_override:

Example Override

jackett_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "jackett2.{{ user.domain }}"
  - "jackett.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

jackett_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
jackett_role_web_host_override:

Example Override

jackett_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'jackett2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

jackett_role_web_http_port

# Type: string (quoted number)
jackett_role_web_http_port:

jackett_role_web_http_scheme

# Type: string ("http"/"https")
jackett_role_web_http_scheme:

jackett_role_web_http_serverstransport

# Type: dict/omit
jackett_role_web_http_serverstransport:

jackett_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
jackett_role_web_scheme:

jackett_role_web_serverstransport

# Type: dict/omit
jackett_role_web_serverstransport:

jackett_role_web_subdomain

# Type: string
jackett_role_web_subdomain: