NZBHydra

Ubuntu 18.04 LTS – Installation de NZBHydra 2 avec Nginx, Docker et SSL/TLS

NZBHydra dispose d’une interface permettant de centraliser l’ensemble de vos indexers. Lorsque vous effectuez une recherche via NZBHydra, celui-ci remonte l’ensemble des résultats des trackers configurés. Il s’intègre parfaitement avec Sonarr et Radarr.

Dans le réseau Usenet, les fichiers sont découpés en plusieurs fichiers RAR (une image ISO de votre distribution Linux préférée de 1.7Go peut-être divisée par exemple en 114 parties de 15 Mo chacun). Pour éviter de chercher à la main les innombrables fichiers que composent une archive, il suffit de se procurer le fichier NZB qui lui correspond. Les fichiers NZB postés par les utilisateurs, sont référencés par des moteurs de recherche (ou indexers). Il existe de nombreux indexers de fichiers NZB accessibles à tous, via un compte ou encore sur invitation. Ils se différencient, comme tout moteur de recherche, par le nombre de fichiers indexés et certains sont spécialisés dans un type de contenu en particulier. C’est pour cela qu’il peut être intéressant d’en avoir plusieurs et c’est là que NZBHydra intervient.

Une fois configuré, NZBHydra permet de faire une recherche via plusieurs indexers en même temps. Il vous donnera également les statistiques sur les différents indexeurs que vous utiliserez. La seule contrainte de NZBHydra est que vos indexers doivent disposer d’une API. Certains indexers, comme NZBGeek, limitent l’accès à leurs API aux comptes premium.

NZBHydra sera accessible depuis l’extérieur via Nginx utilisé comme reverse proxy et sera sécurisé grâce à un certificat SSL/TLS délivré par Let’s Encrypt.

1 – Prérequis

  • Vous devez disposer d’Ubuntu 18.04 LTS.
  • Votre utilisateur doit avoir accès à sudo.
  • Les paquets curl et software-properties-common doivent être installés sur votre système. Dans le doute, tapez la commande suivante :
    $ sudo apt-get install -y curl software-properties-common

Si vous ne possédez pas de serveur dédié ou de nom de domaine, je vous conseille les VPS de 1&1. Les serveurs sont rapides (basés en France), fiables et surtout très abordables. Les formules Cloud S ou Cloud M sont amplement suffisantes.

2 – Installation de Docker & Docker Compose

  • Ajoutez la clé GPG du dépôt officiel de Docker à votre système :
    $ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
    OK
  • Ajoutez Docker à vos dépôts APT :
    $ sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) nightly"
  • Mettez à jour la liste des fichiers disponibles dans vos dépôts APT :
    $ sudo apt-get update
  • Installez Docker CE :
    $ sudo apt-get install -y docker-ce
  • Vérifiez que Docker est correctement installé avec la commande sudo systemctl status docker :
    $ sudo systemctl status docker
    ● docker.service - Docker Application Container Engine
       Loaded: loaded (/lib/systemd/system/docker.service; enabled; vendor preset: enabled)
       Active: active (running) since *** ****-**-** **:**:**CEST; 42s ago
         Docs: https://docs.docker.com
     Main PID: 13232 (dockerd)
  • Téléchargez Docker Compose avec la commande suivante en modifiant la version si besoin avec la dernière release du repository officiel de Docker :
    $ sudo curl -L https://github.com/docker/compose/releases/download/1.21.2/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
  • Ajoutez les droits d’exécution sur le binaire de Docker Compose :
    $ sudo chmod +x /usr/local/bin/docker-compose
  • Vérifiez l’installation de Docker Compose avec la commande docker-compose -v :
    $ docker-compose -v
    docker-compose version 1.21.2, build a133471

3 – Droits Unix

Il est recommandé, pour des raisons de sécurité, de créer un utilisateur dédié à la gestion du volume Docker NZBHydra et de ne pas le lancer sous votre super-utilisateur.

  • Créez un utilisateur nzbhydra :
    $ sudo adduser nzbhydra
  • Ajoutez-le au groupe docker :
    $ sudo adduser nzbhydra docker

4 – Création du volume NZBHydra

  • Connectez-vous sous l’utilisateur nzbhydra et déplacez-vous dans le répertoire personnel de cet utilisateur :
    $ su nzbhydra
    $ cd
  • Créez le fichier /home/nzbhydra/docker-compose.yml et modifiez les lignes en surbrillance en fonction de votre configuration :
    nzbhydra:
      image: linuxserver/hydra2:latest
      container_name: nzbhydra
      restart: always
      ports:
        - 5076:5076
      environment:
        - PUID=1001
        - PGID=1001
        - TZ=Europe/Paris
      volumes:
        - /home/nzbhydra/config:/config
        - /home/nzbhydra/downloads:/downloads
    • PUID et GUID : ces deux variables représentent respectivement l’identifiant et le groupe de votre utilisateur nzbhydra. Ces valeurs peuvent être différentes d’un système à l’autre. Tapez la commande suivante pour obtenir le PUID (=uid) et GUID (=gid) de votre utilisateur nzbhydra :
      $ id nzbhydra
      uid=1001(nzbhydra) gid=1001(nzbhydra) groups=1001(nzbhydra),999(docker)
    • /home/nzbhydra/config:/config : chemin absolu des répertoires partagés entre votre système et le container docker. La première partie /home/nzbhydra/config (avant le séparateur « : ») représente le chemin où le fichier de configuration sera stocké sur votre système. La deuxième partie /config représente le chemin du fichier de configuration à l’intérieur du container docker. Cette dernière ne doit pas être modifiée.
    • /home/nzbhydra/downloads:/downloads : même principe mais pour l’emplacement de vos fichiers téléchargés.

    Il est important que l’utilisateur nzbhydra ait les droits de lecture et d’écriture dans les répertoires de votre système que vous spécifiez.

  • Démarrez le container nzbhydra :
    $ docker-compose up -d
  • Listez vos containers avec la commande $ docker ps -a :
    $ docker ps -a
    CONTAINER ID        IMAGE                        COMMAND             CREATED             STATUS              PORTS                    NAMES
    cea2005870b3        linuxserver/hydra2:latest    "/init"             42 seconds ago      Up 42 seconds       0.0.0.0:5076->5076/tcp   nzbhydra
    

    Si vous êtes en local, vous pouvez désormais accéder à NZBHydra via http://localhost:5076.

5 – Reverse proxy avec Nginx

Si vous souhaitez accéder à NZBHydra de l’extérieur via une URL de type http://nzbhydra.mondomaine.com/ alors un reverse proxy est nécessaire. Le reverse proxy remplit le rôle de passerelle entre l’extérieur (Internet) et le réseau local de votre serveur.

N’oubliez pas de modifier les règles DNS dans l’interface administrateur du fournisseur de votre nom de domaine pour pointer vers l’IP de votre serveur.

Notre choix se portera sur le serveur HTTP Nginx pour une question de performances. Nginx est reconnu pour ses hautes performances, sa stabilité, son ensemble de fonctionnalités, sa configuration simple ainsi que sa faible consommation en ressources.

  • Repassez sous votre super-utilisateur :
    $ exit
  • Installez le paquet nginx :
    $ sudo apt-get -y install nginx
  • Modifiez les directives suivantes du fichier de configuration Nginx /etc/nginx/nginx.conf :
    user www-data;
    worker_processes 8;
    pid /run/nginx.pid;
    include /etc/nginx/modules-enabled/*.conf;
    
    events {
        worker_connections 768;
        # multi_accept on;                                                                                                                                                                                                                   
    }
    
    http {
    
        ##                                                                                                                                                                                                                                   
        # Basic Settings                                                                                                                                                                                                                     
        ##                                                                                                                                                                                                                                   
    
        sendfile on;
        tcp_nopush on;
        tcp_nodelay on;
        keepalive_timeout 65;
        types_hash_max_size 2048;
        server_tokens off;                                                                                                                                                                                                                 
    
        # server_names_hash_bucket_size 64;                                                                                                                                                                                                  
        # server_name_in_redirect off;                                                                                                                                                                                                       
    
        include /etc/nginx/mime.types;
        default_type application/octet-stream;
    
    ...
    • worker_processes 8; : l’un des paramètres à ajuster immédiatement est le worker_processes. Pour profiter pleinement de la puissance de votre serveur, il est recommandé de mettre autant de worker_processes que de cœurs disponibles sur votre serveur. Pour connaître le nombre de cœurs sur votre serveur, il suffit de lancer la commande :
      $ grep processor /proc/cpuinfo | wc -l
      8
    • server_tokens off; : pour des raisons de sécurité, il est recommandé de désactiver l’envoi d’informations telles que le numéro de version de votre Nginx. Pour cela, décommentez cette directive dans le bloc http.
  • Créez le virtual host /etc/nginx/sites-available/nzbhydra et modifiez la ligne en surbrillance en fonction de votre configuration :
    server {
        listen         80;
        listen         [::]:80;
        server_name    nzbhydra.mondomaine.com;
    
        location / {
            proxy_pass http://localhost:5076;
            include    proxy_params;
        }
    }
  • Activez le virtual host :
    $ sudo ln -s /etc/nginx/sites-available/nzbhydra /etc/nginx/sites-enabled/nzbhydra
  • Rechargez la configuration Nginx :
    $ sudo systemctl reload nginx.service

    NZBHydra est désormais accessible via http://nzbhydra.mondomaine.com.

(Facultatif) URL de type http://www.mondomaine.com/nzbhydra

Si l’URL d’accès à votre NZBHydra n’est pas la racine de votre domaine (http://www.mondomaine.com/nzbhydra par exemple), il est nécessaire de le configurer dans NZBHydra.

  • Connectez-vous avec l’utilisateur nzbhydra :
    $ su nzbhydra
  • Arrêtez le container nzbhydra :
    $ docker-compose stop nzbhydra
  • Modifiez la valeur de la propriété urlBase (ligne 333) dans le fichier de configuration de NZBHydra /home/media/nzbhydra/config/nzbhydra.yml :
    ...
    main:
      apiKey: "424242424242424242"
      configVersion: 3
      backupEverySunday: true
      backupBeforeUpdate: true
      deleteBackupsAfterWeeks: 4
      dereferer: "http://www.dereferer.org/?$s"
      host: "0.0.0.0"
      logging:
        consolelevel: "INFO"
        historyUserInfoType: "NONE"
        logIpAddresses: true
        logMaxHistory: 30
        logfilelevel: "INFO"
        logUsername: false
        markersToLog: []
      port: 5076
      proxyType: "NONE"
      proxyHost: null
      proxyPort: 1080
      proxyIgnoreLocal: true
      proxyIgnoreDomains: []
      proxyUsername: null
      proxyPassword: null
      repositoryBase: "https://github.com/theotherp"
      showNews: true
      shutdownForRestart: false
      sniDisabledFor:
      - "nzbgeek.info"
      ssl: false
      sslKeyStore: null
      sslKeyStorePassword: null
      startupBrowser: true
      theme: "grey"
      urlBase: "/nzbhydra"
    ...
    
  • Démarrez le container nzbhydra :
    $ docker-compose start nzbhydra
  • Fermez la session de l’utilisateur nzbhydra et revenez sous votre super-utilisateur :
    $ exit
  • Modifiez les lignes en surbrillance dans votre virtual host (/etc/nginx/sites-available/nzbhydra) :
    server {
        listen         80;
        listen         [::]:80;
        server_name    www.mondomaine.com;
    
        location /nzbhydra {
            proxy_pass http://localhost:5076;
            include    proxy_params;
        }
    }
  • Rechargez la configuration Nginx :
    $ sudo systemctl reload nginx.service

    NZBHydra est désormais accessible via http://www.mondomaine.com/nzbhydra.

6 – Sécuriser NZBHydra avec SSL/TLS

Let’s Encrypt est une autorité de certification libre, automatisée et ouverte. Cette autorité fournit des certificats gratuits X.509 pour le protocole cryptographique SSL/TLS au moyen d’un processus automatisé destiné à se passer du processus complexe actuel impliquant la création manuelle, la validation, la signature, l’installation et le renouvellement des certificats pour la sécurisation des sites internet. En mai 2018, Let’s Encrypt avait délivré plus de 70 millions de certificats.

6.1 – Installation

Installez les paquets software-properties-common et certbot :

$ sudo apt-get install -y software-properties-common
$ sudo add-apt-repository ppa:certbot/certbot
$ sudo apt-get update
$ sudo apt-get install -y certbot

6.2 – Génération des certificats

Let’s Encrypt permet de générer de différentes façons plus ou moins automatisées un certificat. La méthode standalone permet de générer simplement un certificat. En revanche, celle-ci demande d’arrêter le serveur Nginx et ceci est valable à chaque renouvellement dudit certificat. Il existe aussi des plugins apache et nginx entièrement automatisés. Ces plugins mettent à jour automatiquement la configuration des virtual hosts mais le plugin nginx est encore expérimental. Dans cet article, nous recommandons d’utiliser le plugin webroot qui permet de générer et renouveler son certificat sans interrompre le serveur Nginx.

Le plugin webroot crée un fichier temporaire .well-known/acme-challenge dans un dossier spécifique accessible à Nginx, celui-ci permettra aux serveurs de Let’s Encrypt d’appeler ce fichier temporaire et ainsi de valider votre certificat.

  • Créez le répertoire destiné au fichier temporaire de Let’s Encrypt :
    $ sudo mkdir -p /var/www/letsencrypt
  • Créez le fichier /etc/nginx/snippets/letsencrypt avec les lignes suivantes pour rediriger Let’s Encrypt vers le dossier local précédemment créé :
    location ^~ /.well-known/acme-challenge/ {
        default_type "text/plain";
        root         /var/www/letsencrypt;
    }
    
  • Importez le fichier précédemment créé dans votre virtual host :
    server {
        listen         80;
        listen         [::]:80;
        server_name    nzbhydra.mondomaine.com;
    
        location / {
            proxy_pass http://localhost:5076;
            include    proxy_params;
        }
    
        include        /etc/nginx/snippets/letsencrypt;
    }
  • Recharchez votre configuration Nginx :
    $ sudo systemctl reload nginx.service
  • Générez votre certificat en remplaçant email@mondomaine.com et nzbhydra.mondomaine.com par vos informations personnelles :
    $ sudo certbot certonly --webroot -w /var/www/letsencrypt --agree-tos --no-eff-email --email email@mondomaine.com -d nzbhydra.mondomaine.com --rsa-key-size 4096
    Saving debug log to /var/log/letsencrypt/letsencrypt.log
    Obtaining a new certificate
    Performing the following challenges:
    http-01 challenge for nzbhydra.mondomaine.com
    Using the webroot path /var/www/letsencrypt for all unmatched domains.
    Waiting for verification...
    Cleaning up challenges
    
    IMPORTANT NOTES:
     - Congratulations! Your certificate and chain have been saved at
       /etc/letsencrypt/live/nzbhydra.mondomaine.com/fullchain.pem. Your cert
       will expire on 20XX-XX-XX. To obtain a new or tweaked version of
       this certificate in the future, simply run certbot again. To
       non-interactively renew *all* of your certificates, run "certbot
       renew"
     - If you like Certbot, please consider supporting our work by:
    
       Donating to ISRG / Let's Encrypt:   https://letsencrypt.org/donate
       Donating to EFF:                    https://eff.org/donate-le
    

    Vous obtiendrez 4 fichiers dans le répertoire /etc/letsencrypt/live/nzbhydra.mondomaine.com :

    • cert.pem : le certificat de votre domaine nzbhydra.mondomaine.com
    • chain.pem : le certificat Let’s Encrypt
    • fullchain.pem : les certificats cert.pem et chain.pem combinés
    • privkey.pem : la clé privée du certificat.
  • SSL/TLS utilise un système de chiffrement asymétrique (comme RSA ou Diffie-Hellman) afin de sécuriser les échanges de vos flux. Par défaut, Nginx utilise une clé de 1048 bits. En augmentant la longueur de la clé à 4096 bits, vous augmenterez ainsi la sécurité de votre protocole SSL/TLS. Générez une nouvelle clé Diffie-Hellman (DH) de 4096 bits et attribuez-lui un minimum de permissions :
    $ sudo openssl dhparam -out /etc/ssl/certs/dhparam.pem 4096
    $ sudo chmod 600 /etc/ssl/certs/dhparam.pem

6.3 – Renouvellement automatique du certificat

Les certificats délivrés par Let’s Encrypt sont valides 90 jours. L’outil certbot fournit une option renew permettant de renouveler l’ensemble des certificats présents sur votre serveur si et seulement si ceux-ci expirent dans moins de 30 jours.

Nous allons créer une règle crontab où le script de renouvellement sera planifié pour exécution tous les lundis à 23h42. Les traces liées à l’exécution du script seront enregistrées dans un fichier /var/log/le-renew.log.

  • Éditez la crontab :
    sudo crontab -e
  • Ajoutez la ligne suivante :
    42 23 * * 1 /usr/bin/certbot renew >> /var/log/le-renew.log
  • Sauvegardez et quittez.

6.4 – Vhost

  • Modifiez votre virtual host et les lignes en surbrillance en fonction de votre configuration :
    server {
        listen                    80;
        listen                    [::]:80;
        server_name               nzbhydra.mondomaine.com;
        return                    301 https://$server_name$request_uri;
    }
    
    server {
        listen                    443 ssl;
        listen                    [::]:443 ssl;
        server_name               nzbhydra.mondomaine.com;
    
        ssl_certificate           /etc/letsencrypt/live/nzbhydra.mondomaine.com/fullchain.pem;
        ssl_certificate_key       /etc/letsencrypt/live/nzbhydra.mondomaine.com/privkey.pem;
        ssl_trusted_certificate   /etc/letsencrypt/live/nzbhydra.mondomaine.com/chain.pem;
        ssl_dhparam               /etc/ssl/certs/dhparam.pem;
    
        ssl_protocols             TLSv1 TLSv1.1 TLSv1.2;
        ssl_prefer_server_ciphers on;
        ssl_ciphers               'kEECDH+ECDSA+AES128 kEECDH+ECDSA+AES256 kEECDH+AES128 kEECDH+AES256 kEDH+AES128 kEDH+AES256 DES-CBC3-SHA +SHA !aNULL !eNULL !LOW !kECDH !DSS !MD5 !EXP !PSK !SRP !CAMELLIA !SEED';
        ssl_ecdh_curve            secp384r1;
        ssl_session_cache         shared:SSL:1m;
        ssl_session_timeout       1440m;
        ssl_stapling              on;
        ssl_stapling_verify       on;
        ssl_buffer_size           8k;
        add_header                Strict-Transport-Security "max-age=63072000";
    	
        location / {
            proxy_pass            http://localhost:5076;
            include               proxy_params;
        }
    
        include                   /etc/nginx/snippets/letsencrypt;
    }
  • Rechargez votre configuration Nginx :
    $ sudo systemctl reload nginx.service

7 – HTTP2

Je vous conseille vivement d’activer le nouveau protocole HTTP2 qui augmentera la sécurité et la rapidité de votre NZBHydra.

HTTP2 permet notamment :

  • la compression des headers des requêtes et des réponses réduisant la bande passante lorsque les headers (comme les cookies) sont similaires.
  • le multiplexage des requêtes au serveur consistant à faire passer de multiples informations via un seul tuyau de transmission. Ainsi, on économise les multiples connexions entre le client et le serveur. Les requêtes, quant à elles, sont effectuées simultanément par le navigateur. Les requêtes ne se suivent donc plus les unes derrière les autres (HTTP1) et les plus prioritaires (CSS par exemple) ne sont plus bloquées par les moins prioritaires (images par exemple).
  • le push des ressources du serveur au navigateur. Désormais, le serveur pourra envoyer l’ensemble des ressources référencées dans une même page (CSS, JS…), avant même que le navigateur n’ait analysé celle-ci.

L’activation du protocole HTTP2 est très simple et consiste en l’ajout de la directive http2 dans votre virtual host (/etc/nginx/sites-available/nzbhydra) :

server {
    listen                    80;
    listen                    [::]:80;
    server_name               nzbhydra.mondomaine.com;
    return                    301 https://$server_name$request_uri;
}

server {
    listen                    443 ssl http2;
    listen                    [::]:443 ssl http2;
    server_name               nzbhydra.mondomaine.com;

    [...]

}

Une fois la modification effectuée, n’oubliez pas de recharger votre configuration Nginx :

$ sudo systemctl reload nginx.service

8 – Configuration

8.1 – NZBHydra

  1. Accédez à NZBHydra via https://nzbhydra.mondomaine.com/.
  2. Commencez par restreindre l’accès à NZBHydra en activant l’authentification. Cliquez sur l’onglet « Config » puis « Authorization » :

    1
    2
    3
    4
    5
    blank
    1

    Sélectionnez Login form

    2

    Cliquez sur Add new user

    3

    Renseignez un nom d’utilisateur

    4

    Renseignez un mot de passe

    5

    Sauvegardez


  3. (Facultatif) Si vous possédez vos propres indexers, ajoutez-les dans l’onglet « Indexers » :

    1
    2
    3
    4
    5
    6
    blank
    1

    Renseignez un nom d’indexer (purement indicatif)

    2

    Renseignez l’URL de l’API de votre indexer

    3

    Renseignez la clé de l’API (à récupérer chez votre indexer)

    4

    Renseignez l’utilisateur de connexion de votre indexer

    5

    Renseignez le mot de passe de connexion de votre indexer

    6

    Validez


  4. Terminez par ajouter votre grabber (SABnzbd ou NZBGet par exemple) dans l’onglet « Downloaders » :

    1
    2
    3
    4
    5
    6
    blank
    1

    Renseignez un nom pour votre client (purement indicatif)

    2

    Renseignez le nom de domaine ou l’IP de votre serveur

    3

    Renseignez le port de connexion de votre grabber

    4

    Renseignez l’utilisateur de connexion de votre grabber

    5

    Renseignez le mot de passe de connexion de votre grabber

    6

    Validez


8.2 – Sonarr

  • Ajoutez NZBHydra dans l’onglet « Indexers » et choisissez un indexer Usenet de type Newznab (Custom).

    La clé de l’API est à récupérer dans NZBHydra (menu « Config », section « Security »).

    Les catégories 5000, 5030, 5040 et 5070 correspondent respectivement aux catégories TV, TV SD, TV HD et Anime. Toutes les catégories sont visibles dans NZBHydra (menu « Config », section « Categories »).


    1
    2
    3
    4
    5
    6
    7
    blank
    1

    Spécifiez un nom pour votre indexer (purement indicatif)

    2

    Renseignez l’URL de votre NZBHydra

    3

    Récupérez la clé de l’API de votre NZBHydra (menu « Config », section « Security »)

    4

    Les catégories 5000, 5030, 5040 correspondent respectivement aux catégories TV, TV SD et TV HD

    5

    La catégorie 5070 correspond à la catégorie Anime

    6

    Testez votre configuration

    7

    Si le test est passé, sauvegardez votre configuration


8.3 – Radarr

  • Ajoutez NZBHydra dans l’onglet « Indexers ». Choisissez un indexer Usenet de type Newznab (Custom).

    La clé de l’API est à récupérer dans NZBHydra (menu « Config », section « Security ») :


    1
    2
    3
    4
    5
    blank
    1

    Spécifiez un nom pour votre indexer (purement indicatif)

    2

    Renseignez l’URL de votre NZBHydra

    3

    Récupérez la clé de l’API de votre NZBHydra (menu « Config », section « Security »)

    4

    Testez les informations saisies

    5

    Si le test est passé, sauvegardez votre configuration



Ubuntu 18.04 Server LTSDocker 18.06.0-ce
Docker Compose 1.21.2
Nginx 1.14.0
NZBHydra 2 1.5.1
Sonarr 2.0.0.5228
Radarr 0.2.0.1120

0 réponses

Laisser un commentaire

Participez-vous à la discussion?
N'hésitez pas à contribuer!

Laisser un commentaire

Votre adresse de messagerie ne sera pas publiée. Les champs obligatoires sont indiqués avec *