mirror
/
docker-documentation
kopia lustrzana https://github.com/linuxserver/docker-documentation
1
0
Forkuj 0
Kod Zgłoszenia Packages Projekty Wydania Wiki Aktywność

Bot Updating Templated Files

pull/1/head
LinuxServer-CI 2019-02-11 19:32:09 -05:00
rodzic 410d407b00
commit 2f37e5e09b
1 zmienionych plików z 112 dodań i 65 usunięć
Pokaż statystyki Ściągnij plik aktualizacji Ściągnij plik porównania Expand all files Collapse all files

177
images/docker-jackett.md
Wyświetl plik

@ -1,102 +1,149 @@
[linuxserverurl]: https://linuxserver.io # [linuxserver/jackett](https://github.com/linuxserver/docker-jackett)
[forumurl]: https://forum.linuxserver.io
[ircurl]: https://www.linuxserver.io/irc/
[podcasturl]: https://www.linuxserver.io/podcast/
[appurl]: https://github.com/Jackett/Jackett
[hub]: https://hub.docker.com/r/linuxserver/jackett/
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl] [![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
[![](https://images.microbadger.com/badges/version/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett "Get your own version badge on microbadger.com")
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/jackett.svg)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/jackett.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-jackett/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-jackett/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/index.html)
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at: [Jackett](https://github.com/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.
* [forum.linuxserver.io][forumurl]
* [IRC][ircurl] on freenode at `#linuxserver.io`
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
# linuxserver/jackett ## Supported Architectures
[![](https://images.microbadger.com/badges/version/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/jackett.svg)](https://microbadger.com/images/linuxserver/jackett "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/jackett.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/jackett.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-jackett)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-jackett/)
[Jackett][appurl] 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. Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
Simply pulling `linuxserver/jackett` 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 | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
[![jackett](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/jackett-banner.png)][appurl]
## Usage ## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
``` ```
docker create \ docker create \
--name=jackett \ --name=jackett \
-v <path to data>:/config \ -e PUID=1001 \
-v <path to blackhole>:/downloads \ -e PGID=1001 \
-e PGID=<gid> -e PUID=<uid> \ -e TZ=Europe/London \
-e TZ=<timezone> \ -e RUN_OPTS=<run options here> `#optional` \
-v /etc/localtime:/etc/localtime:ro \ -p 9117:9117 \
-p 9117:9117 \ -v <path to data>:/config \
linuxserver/jackett -v <path to blackhole>:/downloads \
--restart unless-stopped \
linuxserver/jackett
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
jackett:
image: linuxserver/jackett
container_name: jackett
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
- RUN_OPTS=<run options here> #optional
volumes:
- <path to data>:/config
- <path to blackhole>:/downloads
ports:
- 9117:9117
mem_limit: 4096m
restart: unless-stopped
``` ```
## Parameters ## Parameters
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. 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.
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 ### Ports (`-p`)
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
| Parameter | Function |
| :----: | --- |
| `9117` | WebUI |
* `-p 9117` - the port(s) ### Environment Variables (`-e`)
* `-v /config` - where Jackett should store its config file.
* `-v /downloads` - Path to torrent blackhole
* `-v /etc/localtime` for timesync - see [Localtime](#localtime) for important information
* `-e TZ` for timezone information, Europe/London - see [Localtime](#localtime) for important information
* `-e RUN_OPTS` - Optionally specify additional arguments to be passed. EG. `--ProxyConnection=10.0.0.100:1234`
* `-e PGID` for GroupID - see below for explanation
* `-e PUID` for UserID - see below for explanation
It is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it jackett /bin/bash`. | Env | Function |
| :----: | --- |
| `PUID=1001` | for UserID - see below for explanation |
| `PGID=1001` | for GroupID - see below for explanation |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
| `RUN_OPTS=<run options here>` | Optionally specify additional arguments to be passed. EG. `--ProxyConnection=10.0.0.100:1234`. |
## Localtime ### Volume Mappings (`-v`)
It is important that you either set `-v /etc/localtime:/etc/localtime:ro` or the TZ variable, mono will throw exceptions without one of them set. | Volume | Function |
| :----: | --- |
| `/config` | Where Jackett should store its config file. |
| `/downloads` | Path to torrent blackhole. |
### User / Group Identifiers
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below: ## 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=1001` and `PGID=1001`, to find yours use `id user` as below:
``` ```
$ id <dockeruser> $ id username
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
``` ```
## Setting up the application ## Application Setup
The web interface is at `<your-ip>:9117` , configure various trackers and connections to other apps there. The web interface is at `<your-ip>:9117` , configure various trackers and connections to other apps there.
More info at [Jackett][appurl]. More info at [Jackett](https://github.com/Jackett/Jackett).
Disable autoupdates in the webui to prevent jackett crashing, the image is refreshed weekly so pick up updates that way. Disable autoupdates in the webui to prevent jackett crashing, the image is refreshed when new versions are released.
## Info
* To monitor the logs of the container in realtime `docker logs -f jackett`.
* container version number ## Support Info
`docker inspect -f '{{ index .Config.Labels "build_version" }}' jackett` * Shell access whilst the container is running:
* `docker exec -it jackett /bin/bash`
* image version number * To monitor the logs of the container in realtime:
* `docker logs -f jackett`
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/jackett` * Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' jackett`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/jackett`
## Versions ## Versions
+ **11.06.18:** Ensure root ownership of Jackett files. * **11.02.19:** - Add pipeline logic and multi arch.
+ **09.02.18:** Add --NoUpdates flag. * **11.06.18:** - Ensure root ownership of Jackett files.
+ **13.12.17:** Fix continuation lines. * **13.12.17:** - Fix continuation lines.
+ **17.04.17:** Switch to using inhouse mono baseimage, ubuntu xenial based. * **17.04.17:** - Switch to using inhouse mono baseimage, ubuntu xenial based.
+ **09.02.17:** Rebase to alpine 3.5. * **09.02.17:** - Rebase to alpine 3.5.
+ **29.10.16:** Call python2 from edge main to satisfy new mono dependency. * **29.10.16:** - Call python2 from edge main to satisfy new mono dependency.
+ **14.10.16:** Add version layer information. * **14.10.16:** - Add version layer information.
+ **22.09.16:** Remove autoupdate, tidy up Dockerfile. * **22.09.16:** - Remove autoupdate, tidy up Dockerfile.
+ **10.09.16:** Add layer badges to README. * **10.09.16:** - Add layer badges to README.
+ **28.08.16:** Add badges to README. * **28.08.16:** - Add badges to README.
+ **06.08.16:** Rebase to alpine linux for smaller image. * **06.08.16:** - Rebase to alpine linux for smaller image.
+ **25.01.16:** Initial Release. * **25.01.16:** - Initial Release.