docker-documentation/docs/images/docker-nzbhydra2.md

12 KiB

title
nzbhydra2

linuxserver/nzbhydra2

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Nzbhydra2 is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application NZBHydra.

It provides easy access to a number of raw and newznab based indexers. The application NZBHydra 2 is replacing NZBHydra 1 and supports migrating from V1. 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. NOTE: The last version that supports migration is linuxserver/nzbhydra2:v2.10.2-ls49

nzbhydra2

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/nzbhydra2:latest 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 Available Tag
x86-64 amd64-<version tag>
arm64 arm64v8-<version tag>
armhf

Version Tags

This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.

Tag Available Description
latest Stable releases
dev Prereleases from their GitHub

Application Setup

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

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

---
services:
  nzbhydra2:
    image: lscr.io/linuxserver/nzbhydra2:latest
    container_name: nzbhydra2
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Etc/UTC
    volumes:
      - /path/to/data:/config
      - /nzb/download:/downloads
    ports:
      - 5076:5076
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=nzbhydra2 \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 5076:5076 \
  -v /path/to/data:/config \
  -v /nzb/download:/downloads \
  --restart unless-stopped \
  lscr.io/linuxserver/nzbhydra2:latest

Parameters

Containers 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
5076 WebUI

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
TZ=Etc/UTC specify a timezone to use, see this list.

Volume Mappings (-v)

Volume Function
/config Where nzbhydra2 should store config files.
/downloads NZB download folder.

Miscellaneous Options

Parameter Function

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__MYVAR=/run/secrets/mysecretvariable

Will set the environment variable MYVAR based on the contents of the /run/secrets/mysecretvariable 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 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.

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 your_user as below:

id your_user

Example output:

uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)

Docker Mods

Docker Mods Docker Universal Mods

We publish various 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.

Support Info

  • Shell access whilst the container is running:

    docker exec -it nzbhydra2 /bin/bash
    
  • To monitor the logs of the container in realtime:

    docker logs -f nzbhydra2
    
  • Container version number:

    docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbhydra2
    
  • Image version number:

    docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nzbhydra2:latest
    

Updating Info

Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.

Below are the instructions for updating containers:

Via Docker Compose

  • Update images:

    • All images:

      docker-compose pull
      
    • Single image:

      docker-compose pull nzbhydra2
      
  • Update containers:

    • All containers:

      docker-compose up -d
      
    • Single container:

      docker-compose up -d nzbhydra2
      
  • You can also remove the old dangling images:

    docker image prune
    

Via Docker Run

  • Update the image:

    docker pull lscr.io/linuxserver/nzbhydra2:latest
    
  • Stop the running container:

    docker stop nzbhydra2
    
  • Delete the container:

    docker rm nzbhydra2
    
  • Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)

  • You can also remove the old dangling images:

    docker image prune
    

Image Update Notifications - Diun (Docker Image Update Notifier)

!!! tip

We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/linuxserver/docker-nzbhydra2.git
cd docker-nzbhydra2
docker build \
  --no-cache \
  --pull \
  -t lscr.io/linuxserver/nzbhydra2:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 04.07.23: - Deprecate armhf. As announced here
  • 22.01.23: - Update release URL for arch-specific packages.
  • 20.01.23: - Update dependencies for v5.
  • 10.12.22: - Bump master JRE to v17. Default mapIpToHost to false.
  • 11.09.22: - Migrate to s6v3.
  • 03.05.22: - Rebase to Jammy.
  • 18.04.22: - Rebase to Alpine 3.15.
  • 01.05.20: - Reorganize container, Relocate app to /app/nzbhydra2/bin, Create /app/nzbhydra2/package_info, Use nzbhydra2wrapperPy3.py from zip.
  • 14.04.20: - Correct Name, Hydra2 -> NZBHydra2.
  • 08.01.20: - Switch to python3.
  • 05.01.20: - Add dev tag for prereleases.
  • 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).
  • 10.08.18: - Rebase to ubuntu bionic.
  • 15.04.18: - Change to port 5076 in the Dockerfile.
  • 11.01.18: - Initial Release.