docker-documentation/images/docker-hydra.md

176 wiersze
8.6 KiB
Markdown
Czysty Zwykły widok Historia

2020-11-05 00:52:42 +00:00
# [linuxserver/hydra](https://github.com/linuxserver/docker-hydra)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-hydra.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-hydra)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-hydra.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-hydra/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-hydra/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/Linuxserver.io/docker-hydra/container_registry)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/hydra.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/hydra "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/hydra)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/hydra)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-hydra%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fhydra%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/hydra/latest/index.html)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
[Hydra](https://github.com/theotherp/nzbhydra) is a meta search for NZB indexers and the "spiritual successor" to NZBmegasearcH. It provides easy access to a number of raw and newznab based indexers.
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
## Supported Architectures
2019-02-08 22:37:36 +00:00
2019-09-06 21:37:05 +00:00
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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-02-12 14:26:12 +00:00
2020-11-05 00:52:42 +00:00
Simply pulling `ghcr.io/linuxserver/hydra` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-02-12 14:26:12 +00:00
The architectures supported by this image are:
| Architecture | Tag |
2020-11-05 00:52:42 +00:00
| :----: | --- |
2019-02-12 14:26:12 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
2019-03-24 21:04:05 +00:00
| armhf | arm32v7-latest |
2019-02-08 22:37:36 +00:00
2020-11-05 00:52:42 +00:00
2019-02-08 22:37:36 +00:00
## Usage
2019-02-12 14:26:12 +00:00
Here are some example snippets to help you get started creating a container from this image.
2020-11-05 00:52:42 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-02-12 14:26:12 +00:00
Compatible with docker-compose v2 schemas.
```yaml
---
2020-04-10 21:36:54 +00:00
version: "2.1"
2019-02-12 14:26:12 +00:00
services:
hydra:
2020-11-05 00:52:42 +00:00
image: ghcr.io/linuxserver/hydra
2019-02-12 14:26:12 +00:00
container_name: hydra
environment:
2019-03-01 22:36:39 +00:00
- PUID=1000
- PGID=1000
2019-02-12 14:26:12 +00:00
- TZ=Europe/London
volumes:
- <path to data>:/config
- <nzb download>:/downloads
ports:
- 5075:5075
restart: unless-stopped
2019-02-08 22:37:36 +00:00
```
2020-11-05 00:52:42 +00:00
### docker cli
```
docker run -d \
--name=hydra \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 5075:5075 \
-v <path to data>:/config \
-v <nzb download>:/downloads \
--restart unless-stopped \
ghcr.io/linuxserver/hydra
```
2019-02-08 22:37:36 +00:00
## Parameters
2020-11-05 00:52:42 +00:00
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.
2019-02-12 14:26:12 +00:00
2020-11-05 00:52:42 +00:00
### Ports (`-p`)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
| Parameter | Function |
2020-11-05 00:52:42 +00:00
| :----: | --- |
2019-02-12 14:26:12 +00:00
| `5075` | WebUI |
2019-02-08 22:37:36 +00:00
2020-11-05 00:52:42 +00:00
### Environment Variables (`-e`)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
| Env | Function |
2020-11-05 00:52:42 +00:00
| :----: | --- |
2019-03-01 22:36:39 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2019-02-12 14:26:12 +00:00
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2019-02-08 22:37:36 +00:00
2020-11-05 00:52:42 +00:00
### Volume Mappings (`-v`)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
| Volume | Function |
2020-11-05 00:52:42 +00:00
| :----: | --- |
2019-02-12 14:26:12 +00:00
| `/config` | Where hydra should store config files. |
| `/downloads` | NZB download folder. |
2020-11-05 00:52:42 +00:00
## 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](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-02-12 14:26:12 +00:00
## User / Group Identifiers
2020-11-05 00:52:42 +00:00
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`.
2019-02-12 14:26:12 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2019-03-01 22:36:39 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as below:
2019-02-08 22:37:36 +00:00
2020-11-05 00:52:42 +00:00
```
2019-02-12 14:26:12 +00:00
$ id username
2019-03-01 22:36:39 +00:00
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2019-02-08 22:37:36 +00:00
```
2019-02-12 14:26:12 +00:00
## Application Setup
2019-02-08 22:37:36 +00:00
2020-11-05 00:52:42 +00:00
THIS IMAGE HAS BEEN DEPRECATED.
Please use [linuxserver/nzbhydra2](https://github.com/linuxserver/docker-nzbhydra2) instead.
2019-02-08 22:37:36 +00:00
The web interface is at `<your ip>:5075` , to set up indexers and connections to your nzb download applications.
2020-11-05 00:52:42 +00:00
2020-04-10 21:36:54 +00:00
## Docker Mods
2020-11-05 00:52:42 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=hydra&query=%24.mods%5B%27hydra%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=hydra "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-10 21:36:54 +00:00
2020-11-05 00:52:42 +00:00
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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-10 21:36:54 +00:00
2019-10-04 21:36:55 +00:00
2019-02-12 14:26:12 +00:00
## Support Info
2019-02-08 22:37:36 +00:00
2019-09-06 21:37:05 +00:00
* Shell access whilst the container is running:
2019-02-12 14:26:12 +00:00
* `docker exec -it hydra /bin/bash`
2019-09-06 21:37:05 +00:00
* To monitor the logs of the container in realtime:
2019-02-12 14:26:12 +00:00
* `docker logs -f hydra`
2019-09-06 21:37:05 +00:00
* Container version number
2019-02-12 14:26:12 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' hydra`
* Image version number
2020-11-05 00:52:42 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/hydra`
2019-02-08 22:37:36 +00:00
## Versions
2020-11-05 00:52:42 +00:00
* **04.11.19:** - Deprecated. Please use [linuxserver/nzbhydra2](https://github.com/linuxserver/docker-nzbhydra2) instead.
2019-12-20 22:04:18 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-07-02 15:29:50 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-03-24 21:04:05 +00:00
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
2019-02-24 05:55:54 +00:00
* **22.02.19:** - Rebasing to alpine 3.9.
2019-02-12 14:26:12 +00:00
* **11.02.19:** - Add pipeline logic and multi arch.
* **17.08.18:** - Rebase to alpine 3.8.
* **12.12.17:** - Rebase to alpine 3.7.
* **20.07.17:** - Internal git pull instead of at runtime.
* **25.05.17:** - Rebase to alpine 3.6.
* **07.11.16:** - Move git clone internal to the container,point config, database and log to use same locations for existing users.
* **14.10.16:** - Add version layer information.
* **09.09.16:** - Add layer badges to README.
* **28.08.16:** - Add badges to README.
* **08.08.16:** - Rebase to alpine linux.
* **25.01.16:** - Initial Release.