Wekan

Ubuntu 18.04 LTS – Installation de Wekan avec Docker, Nginx & SSL/TLS

Wekan est une application Kanban open-source et auto-hébergée très similaire à Trello ou encore WorkFlowy. Dans cet article nous allons voir comment procéder à une installation aisée grâce à Docker et Docker Compose. Wekan 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.

Maintenir une liste de tâches personnelles, planifier vos prochaines vacances ou gérer votre nouveau projet révolutionnaire au travail, le Kanban est une méthode en flux tendu pour garder vos tâches organisées. Celui-ci vous donne un aperçu visuel de l’état actuel de votre projet, de sélectionner et prioriser les futures tâches et de se concentrer davantage sur la tâche en cours.

Wekan permet la création d’un Board (tableau correspondant à un projet par exemple), sur lequel sont ajoutées des cards (cartes correspondant à des tâches). Chaque carte peut être déplacée grâce à un simple « drag & drop » sur chacune des colonnes en fonction de l’avancement de la tâche. Avec Wekan, un tableau peut être partagé entre différents utilisateurs et chaque action met à jour le tableau en temps réel. Il est aussi possible d’attribuer des étiquettes de différente couleur (pour regrouper des tâches par fonctionnalité ou encore pour définir une priorité) et d’appliquer des filtres sur ces étiquettes.

Wekan

1 – Prérequis

  • Vous devez disposer d’Ubuntu 18.04 LTS.
  • Votre utilisateur doit avoir accès à sudo.

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) stable"
  • 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 Wekan et de ne pas le lancer sous votre super-utilisateur.

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

4 – Création du volume Wekan

  • Connectez-vous sous l’utilisateur wekan et déplacez-vous dans le répertoire personnel de cet utilisateur :
    $ su wekan
    $ cd
  • Créez le fichier /home/wekan/docker-compose.yml et modifiez les lignes en surbrillance en fonction de votre configuration :
    version: '2'
    
    services:
      wekandb:
        image: mongo:3.2.21
        container_name: wekan-db
        restart: always
        command: mongod --smallfiles --oplogSize 128
        networks:
          - wekan-tier
        expose:
          - 27017
        volumes:
          - wekan-db:/data/db
          - wekan-db-dump:/dump
    
      wekan:
        image: quay.io/wekan/wekan:latest
        container_name: wekan-app
        restart: always
        networks:
          - wekan-tier
        ports:
          - 3000:8080
        environment:
          - MONGO_URL=mongodb://wekandb:27017/wekan
          - ROOT_URL=http://wekan.mondomaine.com
          - MAIL_URL=smtp://mon_utilisateur_gmail:mon_password_gmail@smtp.gmail.com:25/
          - MAIL_FROM='Wekan '
          - WITH_API=true
        depends_on:
          - wekandb
    
    volumes:
      wekan-db:
        driver: local
      wekan-db-dump:
        driver: local
    
    networks:
      wekan-tier:
        driver: bridge
    • ROOT_URL : URL de votre Wekan.
    • MAIL_URL : informations relatives à un compte SMTP pour l’envoi d’emails à partir de Wekan.
    • MAIL_FROM : adresse sous laquelle Wekan enverra les emails.

    Les variables d’environnement MAIL_URL et MAIL_FROM peuvent être supprimées si vous ne souhaitez pas envoyer d’email via Wekan.

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

  • Démarrez le container wekan :
    $ docker-compose up -d
  • Listez vos containers avec la commande $ docker ps -a :
    $ docker ps -a
    CONTAINER ID        IMAGE                        COMMAND                  CREATED             STATUS              PORTS                    NAMES
    7ef51a1939be        wekanteam/wekan:latest       "node /build/main.js"    42 seconds ago      Up 42 seconds       0.0.0.0:3000->80/tcp     wekan-app
    99687619f428        mongo:3.2.20                 "docker-entrypoint..."   42 seconds ago      Up 42 seconds       27017/tcp                wekan-db
    

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

5 – Reverse proxy avec Nginx

Si vous souhaitez accéder à Wekan de l’extérieur via une URL de type http://wekan.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/wekan et modifiez la ligne en surbrillance en fonction de votre configuration :
    server {
        listen         80;
        listen         [::]:80;
        server_name    wekan.mondomaine.com;
    
        location / {
            proxy_pass http://localhost:3000;
            include    proxy_params;
        }
    }
  • Activez le virtual host :
    $ sudo ln -s /etc/nginx/sites-available/wekan /etc/nginx/sites-enabled/wekan
  • Rechargez la configuration Nginx :
    $ sudo systemctl reload nginx.service

    Wekan est désormais accessible via http://wekan.mondomaine.com.

6 – Sécuriser Wekan 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    wekan.mondomaine.com;
    
        location / {
            proxy_pass http://localhost:3000;
            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 wekan.mondomaine.com par vos informations personnelles :
    $ sudo certbot certonly --webroot -w /var/www/letsencrypt --agree-tos --no-eff-email --email email@mondomaine.com -d wekan.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 wekan.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/wekan.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/wekan.mondomaine.com :

    • cert.pem : le certificat de votre domaine wekan.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               wekan.mondomaine.com;
        return                    301 https://$server_name$request_uri;
    }
    
    server {
        listen                    443 ssl;
        listen                    [::]:443 ssl;
        server_name               wekan.mondomaine.com;
    
        ssl_certificate           /etc/letsencrypt/live/wekan.mondomaine.com/fullchain.pem;
        ssl_certificate_key       /etc/letsencrypt/live/wekan.mondomaine.com/privkey.pem;
        ssl_trusted_certificate   /etc/letsencrypt/live/wekan.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:3000;
            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 Wekan.

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/wekan) :

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

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

    [...]

}

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

$ sudo systemctl reload nginx.service

8 – Sauvegarde / Restauration de Wekan

8.1 – Sauvegarde

  • Connectez-vous avec l’utilisateur wekan et rendez-vous dans son dossier personnel :
    $ su wekan
    $ cd
  • Ouvrez une session bash à l’intérieur du container wekan-db contenant la base de données :
    $ docker exec -it wekan-db bash
  • Déplacez-vous dans le répertoire /data :
    $ cd /data
  • Sauvegardez la base de données en lançant la commande suivante :
    $ mongodump
  • Fermez la session bash et quittez le container :
    $ exit
  • Copiez les fichiers de sauvegarde à l’extérieur du container :
    $ docker cp wekan-db:/data/dump .

8.2 – Restauration

  • Connectez-vous avec l’utilisateur wekan et rendez-vous dans son dossier personnel :
    $ su wekan
    $ cd
  • Copiez le répertoire de sauvegarde dump à l’intérieur du container dans le répertoire /data :
    $ docker cp dump wekan-db:/data/
  • Ouvrez une session bash à l’intérieur du container wekan-db contenant la base de données :
    $ docker exec -it wekan-db bash
  • Déplacez-vous dans le répertoire /data :
    $ cd /data
  • Restaurez la base de données en lançant la commande suivante :
    $ mongorestore --drop --db wekan dump/wekan/
  • Fermez la session bash et quittez le container :
    $ exit


Ubuntu 18.04 LTSDocker 18.06.0-ce-dev
Docker Compose 1.21.2
Nginx 1.14.0
Wekan 1.78.0

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 *