From 25bbea60ffa00e7b922df7b6d99f97b4dcb58190 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Sun, 29 Sep 2019 11:17:54 +0100 Subject: [PATCH] Bot Updating Templated Files --- images/docker-hydra2.md | 43 +++++++++++++++++++++++++++-------------- 1 file changed, 28 insertions(+), 15 deletions(-) diff --git a/images/docker-hydra2.md b/images/docker-hydra2.md index 094aed434..451e9b10d 100644 --- a/images/docker-hydra2.md +++ b/images/docker-hydra2.md @@ -1,11 +1,18 @@ -# linuxserver/hydra2 +# [linuxserver/hydra2](https://github.com/linuxserver/docker-hydra2) -[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-hydra2.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-hydra2/releases) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/hydra2) [![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/hydra2) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/hydra2) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/hydra2) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-hydra2/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra2/job/master/) [![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/index.html) +[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-hydra2.svg?style=flat-square&color=E68523)](https://github.com/linuxserver/docker-hydra2/releases) +[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/hydra2 "Get your own version badge on microbadger.com") +[![MicroBadger Size](https://img.shields.io/microbadger/image-size/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/hydra2 "Get your own version badge on microbadger.com") +[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/hydra2) +[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra2.svg?style=flat-square&color=E68523)](https://hub.docker.com/r/linuxserver/hydra2) +[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-hydra2/job/master/badge/icon?style=flat-square)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-hydra2/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/hydra2/latest/index.html) [Hydra2](https://github.com/theotherp/nzbhydra2) is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application [NZBHydra](https://github.com/theotherp/nzbhydra). It provides easy access to a number of raw and newznab based indexers. The application NZBHydra 2 is currently in its early stages and is in active development. Be wary that there may be some compatibility issues for those migrating from V1 to V2, so ensure you back up your old configuration before moving over to the new version. + ## Supported Architectures 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/). @@ -15,18 +22,19 @@ Simply pulling `linuxserver/hydra2` should retrieve the correct image for your a The architectures supported by this image are: | Architecture | Tag | -| :---: | :--- | +| :----: | --- | | x86-64 | amd64-latest | | arm64 | arm64v8-latest | | armhf | arm32v7-latest | + ## Usage Here are some example snippets to help you get started creating a container from this image. ### docker -```text +``` docker create \ --name=hydra2 \ -e PUID=1000 \ @@ -39,6 +47,7 @@ docker create \ linuxserver/hydra2 ``` + ### docker-compose Compatible with docker-compose v2 schemas. @@ -64,38 +73,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 `:` 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 `:` 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 | -| :---: | :--- | +| :----: | --- | | `5076` | 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. | -### Volume Mappings \(`-v`\) +### Volume Mappings (`-v`) | Volume | Function | -| :---: | :--- | +| :----: | --- | | `/config` | Where hydra2 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`. +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) ``` @@ -104,6 +116,8 @@ In this instance `PUID=1000` and `PGID=1000`, to find yours use `id user` as bel The web interface is at `:5076` , to set up indexers and connections to your nzb download applications. + + ## Support Info * Shell access whilst the container is running: @@ -119,8 +133,7 @@ The web interface is at `:5076` , to set up indexers and connections to * **23.03.19:** - Switching to new Base images, shift to arm32v7 tag. * **11.02.19:** - Add pipeline logic and multi arch. -* **18.08.18:** - Bump java version to 10, \(bionic currently refers to it as version 11\). +* **18.08.18:** - Bump java version to 10, (bionic currently refers to it as version 11). * **10.08.18:** - Rebase to ubuntu bionic. * **15.04.18:** - Change to port 5076 in the Dockerfile. * **11.01.18:** - Initial Release. -