Bot Updating Templated Files

2019-02-12 14:26:12 +00:00 · 2019-02-12 14:26:12 +00:00 · 9472eaef04
commit 9472eaef04
--- a/images/docker-hydra.md
+++ b/images/docker-hydra.md
@ -1,90 +1,142 @@
-[linuxserverurl]: https://linuxserver.io
-[forumurl]: https://forum.linuxserver.io
-[ircurl]: https://www.linuxserver.io/irc/
-[podcasturl]: https://www.linuxserver.io/podcast/
-[appurl]: https://github.com/theotherp/nzbhydra
-[hub]: https://hub.docker.com/r/linuxserver/hydra/
+# [linuxserver/hydra](https://github.com/linuxserver/docker-hydra)

-[![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/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)

-The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
-* [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!
+[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.

-# linuxserver/hydra
-[![](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 image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/hydra.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/hydra.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-hydra)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-hydra/)
+## Supported Architectures

-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. [hydra](https://github.com/theotherp/nzbhydra)
+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 |

-[![hydra](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/hydra-icon.png)][appurl]

 ## Usage

+Here are some example snippets to help you get started creating a container from this image.
+
+### docker
+
 ```
-docker create --name=hydra \
+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 \
-e PGID=<gid> -e PUID=<uid> \
-e TZ=<timezone> \
-p 5075:5075 linuxserver/hydra
+  --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
 ```

 ## 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.
-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
-http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
+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`)
+
+| Parameter | Function |
+| :----: | --- |
+| `5075` | WebUI |


-* `-p 5075` - the port(s)
-* `-v /config` - Where hydra should store config files
-* `-v /downloads` - NZB download folder
-* `-e PGID` for GroupID - see below for explanation
-* `-e PUID` for UserID - see below for explanation
-* `-e TZ` for timezone EG. Europe/London
+### Environment Variables (`-e`)

-It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it hydra /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. |

-### User / Group Identifiers
+### Volume Mappings (`-v`)

-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" ™.
+| Volume | Function |
+| :----: | --- |
+| `/config` | Where hydra should store config files. |
+| `/downloads` | NZB download folder. |

-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)
 ```

-## Setting up the application
+## Application Setup

 The web interface is at `<your ip>:5075` , to set up indexers and connections to your nzb download applications.


-## Info

-* To monitor the logs of the container in realtime `docker logs -f hydra`.
+## Support Info

-* 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`
+* 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`

 ## Versions

-+ **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.
+* **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.