Ubuntu 20.04 – Installation de Transmission avec OpenVPN, Traefik, Docker et SSL/TLS

Transmission est un client BitTorrent multiplateforme qui permet le téléchargement et la création de torrents. Il supporte les technologies décentralisées sans tracker, tel que PEX, DHT et les liens magnets. Je vous recommande cependant l’utilisation de Deluge plus léger et plus complet…

• À qui s’adresse ce tutoriel ?

  Cette procédure fonctionne à la fois pour des installations en local, sur VM ou sur serveur dédié (kimsufi, dedibox, etc.). Si vous avez un nom de domaine, nous verrons comment mettre en place un serveur HTTP Traefik et chiffrer vos échanges avec le protocole SSL/TLS, le tout sous Docker.

• Pourquoi Docker et OpenVPN ?

  Transmission sera déployé en quelques minutes ! Transmission sera isolé dans un container Docker. Ce container contientra toutes les dépendances (librairies, démons, configurations, etc.) nécessaires à son exécution sans interférer avec les autres outils ou d’autres services installés sur votre serveur. Enfin la mise à jour sera simplifiée et pourra être totalement automatisée (nous le verrons). L’image Docker sera versionnée et permettra de redéployer une version précédente très facilement.

  L’utilisation d’OpenVPN n’est pas obligatoire dans ce tutoriel mais fortement recommandée. Sachez que votre véritable IP est dévoilée lorsque vous utilisez le réseau P2P. Celle-ci est donc visible par certaines autorités (sans les citer…) et par les autres utilisateurs du réseau.

  L’utilisation d’OpenVPN associé à un VPN permet de masquer votre IP. Les deux VPN présentés dans la suite du tutoriel ne gardent aucune trace de vos connexions (aucune conservation de log) et autorisent l’utilisation du réseau P2P. De plus si pour une raison ou une autre, le VPN venait à tomber, vos téléchargements seraient automatiquement interrompus.

1 – Prérequis

• Vous devez disposer d’Ubuntu 20.04 en version Desktop, Server ou ARM (Raspberry Pi). Si vous disposez d’une version antérieure, vous pouvez mettre à jour votre système en suivant cette procédure.
• 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

• Vos dépôts APT doivent être à jour. Dans le doute, tapez la commande suivante :

  sudo apt-get update

2 – Installation de Docker & Docker Compose

1. Installez Docker :

   sudo apt-get install -y docker.io

2. Vérifiez que Docker est correctement installé avec la commande :

   docker -v
   Docker version 19.03.8, build afacb8b7f0

   La commande doit retourner la version installée de Docker.

3 – Droits Unix et arborescence

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

1. Créez un utilisateur transmission :

   sudo adduser transmission

2. Ajoutez-le au groupe docker :

   sudo adduser transmission docker

3. Dans la suite du tutoriel, les fichiers téléchargés seront déposés dans le dossier /data/torrents :

   data
   └── torrents

   Créez l’arboresence dédiée aux téléchargements :

   sudo mkdir -p /data/torrents

4. Attribuez ces répertoires à l’utilisateur transmission pour éviter de futurs problèmes de permissions :

   sudo chown transmission:transmission /data/torrents

4 – Création du volume Transmission

Trois possibilités s’offrent à vous concernant les volumes Docker. Les deux premières, fortement recommandées, consistent à utiliser une image Docker composée de Transmission et d’OpenVPN. Cette image permet, de façon anonyme et sécurisée, de télécharger vos torrents via une interface VPN. Elle dispose aussi de règles iptables qui font en sorte que si, pour une raison ou une autre, le VPN venait à tomber, les téléchargements seraient interrompus et votre véritable IP ne serait pas dévoilée.

Cette image Docker fonctionne avec les VPN AirVPN et Private Internet Access (PIA). La configuration de PIA est plus rapide à mettre en place mais les tarifs d’AirVPN sont imbattables.
Quelque soit votre choix entre ces deux fournisseurs, vous disposerez d’un VPN rapide, stable, fortement chiffré, confidentiel (aucune conservation d’historique) et adapté au P2P. Après presque 10 ans d’utilisation de ces VPN, je peux vous garantir qu’ils ne laissent aucune trace…

Si vous voulez tester AirVPN (configuration, débits, etc.), je peux vous fournir un accès gratuit pendant 24h. Contactez-moi

La dernière possibilité est de s’affranchir du VPN et d’utiliser une image contenant simplement Transmission. Sachez simplement que votre IP sera visible par les autres utilisateurs du réseau P2P et que vos téléchargements ne seront ni chiffrés, ni anonymes…

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

5 – Reverse proxy avec Traefik

Dans la suite du tutoriel, nous utiliserons l’image avec VPN mais la procédure reste tout à fait compatible avec l’image sans VPN.

Traefik est un reverse-proxy et un load-balancer moderne conçu (par un Français) pour faciliter le déploiement des microservices (Docker, Kubernetes, AWS, etc.). Traefik est extrêmement simple à configurer et gère automatiquement vos certificats délivrés par Let's Encrypt. Il les renouvelle 30 jours avant leurs expirations sans action de votre part. De plus, il est capable de charger vos containers dynamiquement sans interruption de service et dispose d'un dashboard affichant l'ensemble de vos routes configurées.

Si vous avez déjà un Traefik sous Docker, vous pouvez vous rendre directement à l'étape 5.4.

5.1 - Création de l'utilisateur traefik

Si vous avez plusieurs containers ou si vous avez pour projet d'en ajouter par la suite, il est préférable d'isoler le container Traefik. Il est recommandé de ne pas le lancer sous votre super-utilisateur et de créer un utilisateur dédié.

1. Créez un utilisateur traefik :

   sudo adduser traefik

2. Ajoutez-le au groupe docker :

   sudo adduser traefik docker

5.2 - L'image et réseau Traefik

1. Connectez-vous sous l'utilisateur traefik :

   su traefik

2. Déplacez-vous dans le répertoire personnel de cet utilisateur :

   cd

3. Créez le réseau dédié à Traefik et à l'ensemble de vos containers :

   docker network create traefik_network

4. Créez le fichier /home/traefik/docker-compose.yml en ajoutant le contenu suivant :

   version: '3.7'
   services:
     traefik:
       image: "traefik:v2.2"
       container_name: "traefik"
       restart: unless-stopped
       networks:
         - traefik_network
       ports:
         - "80:80"
         - "443:443"
       volumes:
         - /var/run/docker.sock:/var/run/docker.sock:ro
         - /home/traefik/traefik.toml:/traefik.toml:ro
         - /home/traefik/acme.json:/acme.json
   
   networks:
     traefik_network:
       external: true
   

   • /var/run/docker.sock:/var/run/docker.sock:ro : précise le socket Unix de votre docker. Laissez cette valeur par défaut.
   • /home/traefik/traefik.toml:/traefik.toml:ro : précise le chemin du fichier de configuration de Traefik. Nous le créerons à l'étape suivante.
   • /home/traefik/acme.json:/acme.json : précise le chemin du fichier contenant les informations relatives à vos certificats.
   • traefik_network : ici nous spécifions le réseau dédié à Traefik. Nous ajouterons aussi le container Transmission dans ce réseau par la suite.

5.3 - Configuration Traefik

Traefik peut être configuré de différentes manières, nous allons détailler ici, la configuration recommandée par Traefik, à savoir par un fichier statique au format TOML.

1. Traefik stocke les informations liées au certificat dans un fichier acme.json. Vous devez au préalable créer le fichier et lui attribuer un minimum de permissions :

   touch /home/traefik/acme.json && chmod 600 /home/traefik/acme.json

2. Créez le fichier de configuration Traefik /home/traefik/traefik.toml en ajoutant les lignes suivantes. L'unique propriété à modifier est l'email :

   [providers.docker]
     endpoint = "unix:///var/run/docker.sock"
     watch = true
     exposedByDefault = false
   
   [entryPoints.web]
     address = ":80"
     [entryPoints.web.http.redirections.entryPoint]
       to = "websecure"
       scheme = "https"
   
   [entryPoints.websecure]
     address = ":443"
   
   [certificatesResolvers.leresolver.acme]
     email = "votre-adresse@email.com"
     storage = "acme.json"
     [certificatesResolvers.leresolver.acme.httpChallenge]
       entryPoint = "web"

   • [providers.docker] : cette directive permet tout simplement d'activer le support Docker.
   • endpoint = "unix:///var/run/docker.sock" : précise le socket Unix de votre Docker à Traefik. Laissez la valeur par défaut.
   • watch = true : permet de déployer à chaud les containers dès qu'un changement dans la configuration est détectée.
   • exposedByDefault = false : n'expose pas par défaut les containers au monde extérieur. Il est préférable d'activer cette option dans le docker-compose.yml pour chacun des containers dans le cas où, si pour une raison ou une autre, vous ne souhaiteriez plus rendre accessible un container de l'extérieur.
   • [entryPoints.web] et [entryPoints.websecure] : ces directives définissent les points d'entrée de votre Traefik. web et websecure sont purement indicatifs, vous pouvez les nommer autrement mais ils doivent correspondre aux labels que nous définirons plus tard dans le docker-compose.yml. Les propriétés address précisent les ports sur lesquels Traefik « écoute » en fonction du point d'entrée.
   • [entryPoints.web.http.redirections.entryPoint] : force la redirection du port 80 vers le port 443 donc force le HTTP en HTTPS.
   • [certificatesResolvers.[NOM_RESOLVEUR].acme] : nous indiquons ici que nous souhaitons utiliser le protocole ACME (donc le service Let's Encrypt) pour obtenir un certificat. Le nom du résolveur est purement indicatif, il doit simplement correspondre aux labels que nous définirons plus tard dans le docker-compose.yml.
   • storage = "acme.json" : la propriété storage précise à Traefik le fichier (que nous avons créé précédemment) où seront stockées les informations relatives aux certificats. L'erreur commune est d'indiquer le chemin absolu (dans notre cas /home/traefik/acme.json), ici le chemin à renseigner est celui au sein du container Traefik, il faut donc laisser cette valeur par défaut.
   • [certificatesResolvers.[NOM_RESOLVEUR].acme.httpChallenge] : cette directive précise tout simplement par quel point d'entrée (dans notre cas le port 80) Traefik peut obtenir un certificat.

3. Déplacez-vous dans le répertoire personnel de l'utilisateur traefik et démarrez le container :

   cd
   docker-compose up -d

5.4 – Labels et réseau Traefik

1. Connectez-vous sous l’utilisateur transmission et déplacez-vous dans son répertoire personnel :

   su transmission

   cd

2. Dans votre fichier /home/transmission/docker-compose.yml, ajoutez le réseau traefik_network dans la configuration du container Transmission et en fin de fichier. De plus, toutes les expositions de ports sont inutiles, vous pouvez donc supprimer la directive ports: avec les ports associés.

   Enfin, ajoutez les labels permettant de communiquer avec Traefik (seul le domaine est à modifier par le vôtre) :

   version: '3.7'
   services:
     transmission:
       image: haugene/transmission-openvpn:latest
       container_name: transmission
       cap_add:
         - NET_ADMIN
       networks:
         - traefik_network
       sysctls:
         - net.ipv6.conf.all.disable_ipv6=0
       restart: unless-stopped
       ports:
         - 9091:9091
       dns:
         - 8.8.8.8
         - 8.8.4.4
       volumes:
         - /etc/localtime:/etc/localtime:ro
         - ${PATH_MEDIA}:/data
         - ${VPN_PATH}:/etc/openvpn/custom/default.ovpn
       environment:
         - CREATE_TUN_DEVICE=true
         - PUID=${PUID}
         - PGID=${PGID}
         - LOCAL_NETWORK=${LAN_NETWORK}
         - OPENVPN_PROVIDER=CUSTOM
         - OPENVPN_USERNAME=${OPENVPN_USERNAME}
         - OPENVPN_PASSWORD=${OPENVPN_PASSWORD}
         - TRANSMISSION_RPC_AUTHENTICATION_REQUIRED=true
         - TRANSMISSION_RPC_USERNAME=${TRANSMISSION_USERNAME}
         - TRANSMISSION_RPC_PASSWORD=${TRANSMISSION_PASSWORD}
       labels:
         - "traefik.enable=true"
         - "traefik.docker.network=traefik_network"
         - "traefik.http.routers.transmission.entrypoints=web,websecure"
         - "traefik.http.routers.transmission.rule=Host(`transmission.mondomaine.com`)"
         - "traefik.http.services.transmission.loadbalancer.server.port=9091"
         - "traefik.http.routers.transmission.tls=true"
         - "traefik.http.routers.transmission.tls.certresolver=leresolver"
   
   networks:
     traefik_network:
       external: true
   

   • traefik.enable=true : ce label expose le container au monde extérieur. Il surchage la propriété exposedByDefault de votre fichier /home/traefik/traefik.toml.
   • traefik.docker.network=traefik_network : ce label précise à Traefik quel réseau utilise le container Transmission.
   • traefik.http.routers.[NOM_DU_CONTAINER].entrypoints : chaque règle de routage spécifique à un container doit être spécifiée par un nom, ici nous utilisons tout simplement le nom du container. Le label entrypoints précise que les requêtes entrantes sur les points d’entrée web (port 80) et websecure (port 443) seront transmises au container.
   • traefik.http.routers.[NOM_DU_CONTAINER].rule=Host(`transmission.mondomaine.com`) : ici nous précisons une règle, toute requête arrivant sur http://transmission.mondomaine.com sera transmise au container transmission.
   • traefik.http.services.[NOM_DU_CONTAINER].loadbalancer.server.port=[PORT] : ici nous précisons le port du container sur lequel les requêtes doivent être transmises.
   • traefik.http.routers.[NOM_DU_CONTAINER].tls : active le support SSL/TLS.
   • traefik.http.routers.[NOM_DU_CONTAINER].tls.certresolver : précise le résolveur et donc les certificats à utiliser.

3. Déplacez-vous dans le répertoire personnel de l’utilisateur transmission et démarrez le container :

   cd
   docker-compose up -d

   Attention, si vous êtes avec l’image avec VPN, patientez 5 minutes avant d’accéder au container. En effet, ce container contient un healthcheck qui est lancé toutes les 5 minutes. Tant que le healthcheck n’est pas satisfait, Traefik ne crée pas les routes car il détecte le container en erreur. Au démarrage du container, la première tentative échoue car le VPN met un certain temps à se lancer, d’où l’attente d’une deuxième tentative 5 minutes plus tard. Je n’ai malheureusement pas trouvé le moyen de surcharger cela dans le docker-compose.yml, si vous avez une solution, je suis preneur !