10 KiB
title |
---|
jackett |
linuxserver/jackett
Jackett works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, 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.
Supported Architectures
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/jackett:latest
should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture | Available | Tag |
---|---|---|
x86-64 | ✅ | amd64-<version tag> |
arm64 | ✅ | arm64v8-<version tag> |
armhf | ❌ |
Version Tags
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag | Available | Description |
---|---|---|
latest | ✅ | Stable Jackett Releases |
development | ✅ | Latest Jackett Releases |
Application Setup
The web interface is at <your-ip>:9117
, configure various trackers and connections to other apps there.
More info at Jackett.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
---
version: "2.1"
services:
jackett:
image: lscr.io/linuxserver/jackett:latest
container_name: jackett
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- AUTO_UPDATE=true #optional
- RUN_OPTS= #optional
volumes:
- /path/to/data:/config
- /path/to/blackhole:/downloads
ports:
- 9117:9117
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=jackett \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e AUTO_UPDATE=true `#optional` \
-e RUN_OPTS= `#optional` \
-p 9117:9117 \
-v /path/to/data:/config \
-v /path/to/blackhole:/downloads \
--restart unless-stopped \
lscr.io/linuxserver/jackett:latest
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal>
respectively. For example, -p 8080:80
would expose port 80
from inside the container to be accessible from the host's IP on port 8080
outside the container.
Ports (-p
)
Parameter | Function |
---|---|
9117 |
WebUI |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Etc/UTC |
specify a timezone to use, see this list. |
AUTO_UPDATE=true |
Allow Jackett to update inside of the container (currently recommended by Jackett and enabled by default) |
RUN_OPTS= |
Optionally specify additional arguments to be passed. |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Where Jackett should store its config file. |
/downloads |
Path to torrent blackhole. |
Miscellaneous Options
Parameter | Function |
---|
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__
.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD
based on the contents of the /run/secrets/mysecretpassword
file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022
setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v
flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID
and group PGID
.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000
and PGID=1000
, to find yours use id user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
- Shell access whilst the container is running:
docker exec -it jackett /bin/bash
- To monitor the logs of the container in realtime:
docker logs -f jackett
- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' jackett
- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/jackett:latest
Versions
- 11.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Add icu-data-full to address ICU issue with Cyrillic character sets.
- 11.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 10.05.22: - Rebase to Ubuntu Focal.
- 24.05.20: - Allow user to optionally enable auto updates.
- 31.12.19: - Remove agressive startup chowning.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Switch to net-core builds of jackett, not dependant on mono and smaller images.
- 11.02.19: - Add pipeline logic and multi arch.
- 11.06.18: - Ensure root ownership of Jackett files.
- 13.12.17: - Fix continuation lines.
- 17.04.17: - Switch to using inhouse mono baseimage, ubuntu xenial based.
- 09.02.17: - Rebase to alpine 3.5.
- 29.10.16: - Call python2 from edge main to satisfy new mono dependency.
- 14.10.16: - Add version layer information.
- 22.09.16: - Remove autoupdate, tidy up Dockerfile.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 06.08.16: - Rebase to alpine linux for smaller image.
- 25.01.16: - Initial Release.