docker-documentation/images/docker-hydra.md

144 wiersze
5.1 KiB
Markdown
Czysty Zwykły widok Historia

2019-02-12 14:26:12 +00:00
# [linuxserver/hydra](https://github.com/linuxserver/docker-hydra)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
[![](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/hydra.svg)](https://microbadger.com/images/linuxserver/hydra "Get your own version badge on microbadger.com")
[![](https://images.microbadger.com/badges/image/linuxserver/hydra.svg)](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)
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra.svg)
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-hydra/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra/job/master/)
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/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-02-12 14:26:12 +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).
Simply pulling `linuxserver/hydra` 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 |
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.
### docker
2019-02-08 22:37:36 +00:00
```
2019-02-12 14:26:12 +00:00
docker create \
--name=hydra \
-e PUID=1001 \
-e PGID=1001 \
-e TZ=Europe/London \
-p 5075:5075 \
-v <path to data>:/config \
-v <nzb download>:/downloads \
--restart unless-stopped \
linuxserver/hydra
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2"
services:
hydra:
image: linuxserver/hydra
container_name: hydra
environment:
- PUID=1001
- PGID=1001
- TZ=Europe/London
volumes:
- <path to data>:/config
- <nzb download>:/downloads
ports:
- 5075:5075
mem_limit: 4096m
restart: unless-stopped
2019-02-08 22:37:36 +00:00
```
## Parameters
2019-02-12 14:26:12 +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.
### Ports (`-p`)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
| Parameter | Function |
| :----: | --- |
| `5075` | WebUI |
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
### Environment Variables (`-e`)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
| 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. |
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
### Volume Mappings (`-v`)
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
| Volume | Function |
| :----: | --- |
| `/config` | Where hydra should store config files. |
| `/downloads` | NZB download folder. |
## 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:
2019-02-08 22:37:36 +00:00
```
2019-02-12 14:26:12 +00:00
$ id username
2019-02-08 22:37:36 +00:00
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
```
2019-02-12 14:26:12 +00:00
## Application Setup
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.
2019-02-12 14:26:12 +00:00
## Support Info
2019-02-08 22:37:36 +00:00
2019-02-12 14:26:12 +00:00
* Shell access whilst the container is running:
* `docker exec -it hydra /bin/bash`
* To monitor the logs of the container in realtime:
* `docker logs -f hydra`
* Container version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' hydra`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/hydra`
2019-02-08 22:37:36 +00:00
## Versions
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.