kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
8203f26f59
commit
ef7d701aad
|
|
@ -1,8 +1,16 @@
|
|||
# linuxserver/jackett
|
||||
# [linuxserver/jackett](https://github.com/linuxserver/docker-jackett)
|
||||
|
||||
[](https://github.com/linuxserver/docker-jackett) [](https://github.com/linuxserver/docker-jackett/releases) [](https://github.com/linuxserver/docker-jackett/packages) [](https://gitlab.com/Linuxserver.io/docker-jackett/container_registry) [](https://microbadger.com/images/linuxserver/jackett) [](https://hub.docker.com/r/linuxserver/jackett) [](https://hub.docker.com/r/linuxserver/jackett) [](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-jackett/job/master/) [](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/index.html)
|
||||
[](https://github.com/linuxserver/docker-jackett)
|
||||
[](https://github.com/linuxserver/docker-jackett/releases)
|
||||
[](https://github.com/linuxserver/docker-jackett/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-jackett/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/jackett "Get your own version badge on microbadger.com")
|
||||
[](https://hub.docker.com/r/linuxserver/jackett)
|
||||
[](https://hub.docker.com/r/linuxserver/jackett)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-jackett/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/jackett/latest/index.html)
|
||||
|
||||
[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.
|
||||
[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.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
|
|
@ -13,7 +21,7 @@ Simply pulling `linuxserver/jackett` should retrieve the correct image for your
|
|||
The architectures supported by this image are:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
|
|
@ -23,7 +31,7 @@ The architectures supported by this image are:
|
|||
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
|
||||
|
||||
| Tag | Description |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| latest | Stable Jackett Releases |
|
||||
| development | Latest Jackett Releases |
|
||||
|
||||
|
|
@ -33,7 +41,7 @@ Here are some example snippets to help you get started creating a container from
|
|||
|
||||
### docker
|
||||
|
||||
```text
|
||||
```
|
||||
docker create \
|
||||
--name=jackett \
|
||||
-e PUID=1000 \
|
||||
|
|
@ -48,6 +56,7 @@ docker create \
|
|||
linuxserver/jackett
|
||||
```
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
|
@ -75,38 +84,41 @@ services:
|
|||
|
||||
## 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.
|
||||
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`\)
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `9117` | WebUI |
|
||||
|
||||
### Environment Variables \(`-e`\)
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `PUID=1000` | for UserID - see below for explanation |
|
||||
| `PGID=1000` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `AUTO_UPDATE=true` | Allow Jackett to update inside of the container \(currently recommended by Jackett and enabled by default\) |
|
||||
| `AUTO_UPDATE=true` | Allow Jackett to update inside of the container (currently recommended by Jackett and enabled by default) |
|
||||
| `RUN_OPTS=<run options here>` | Optionally specify additional arguments to be passed. EG. `--ProxyConnection=10.0.0.100:1234`. |
|
||||
|
||||
### Volume Mappings \(`-v`\)
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :---: | :--- |
|
||||
| :----: | --- |
|
||||
| `/config` | Where Jackett should store its config file. |
|
||||
| `/downloads` | Path to torrent blackhole. |
|
||||
|
||||
## Environment variables from files \(Docker secrets\)
|
||||
|
||||
|
||||
## Environment variables from files (Docker secrets)
|
||||
|
||||
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||
|
||||
As an example:
|
||||
|
||||
```text
|
||||
```
|
||||
-e FILE__PASSWORD=/run/secrets/mysecretpassword
|
||||
```
|
||||
|
||||
|
|
@ -114,32 +126,36 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/
|
|||
|
||||
## 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](https://en.wikipedia.org/wiki/Umask) before asking for support.
|
||||
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](https://en.wikipedia.org/wiki/Umask) 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`.
|
||||
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:
|
||||
|
||||
```text
|
||||
```
|
||||
$ id username
|
||||
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||
```
|
||||
|
||||
## Application Setup
|
||||
|
||||
The web interface is at `<your-ip>:9117` , configure various trackers and connections to other apps there. More info at [Jackett](https://github.com/Jackett/Jackett).
|
||||
The web interface is at `<your-ip>:9117` , configure various trackers and connections to other apps there.
|
||||
More info at [Jackett](https://github.com/Jackett/Jackett).
|
||||
|
||||
Disable autoupdates in the webui to prevent jackett crashing, the image is refreshed when new versions are released.
|
||||
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=jackett "view available mods for this container.")
|
||||
|
||||
[](https://mods.linuxserver.io/?mod=jackett)
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image \(if any\) can be accessed via the dynamic badge above.
|
||||
|
||||
## Support Info
|
||||
|
||||
|
|
@ -170,4 +186,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
|||
* **28.08.16:** - Add badges to README.
|
||||
* **06.08.16:** - Rebase to alpine linux for smaller image.
|
||||
* **25.01.16:** - Initial Release.
|
||||
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue