Comment auto-héberger HedgeDoc sur un VPS (Guide complet)

Introduction

HedgeDoc est un éditeur markdown collaboratif qui permet à plusieurs utilisateurs d’éditer des documents en temps réel. Il est souvent utilisé pour la prise de notes et la documentation au sein des équipes. Auto-héberger HedgeDoc sur un serveur privé virtuel (VPS) vous donne un contrôle total sur vos données et garantit la confidentialité. Dans ce guide, nous vous guiderons à travers les étapes pour installer HedgeDoc sur un VPS en utilisant Docker.

Prérequis

1. Un VPS : Choisissez un fournisseur de VPS adapté. Voici une comparaison rapide de quelques options populaires :

Pour des comparaisons détaillées des différents fournisseurs de VPS, consultez notre comparaison complète de VPS.

2. Accès SSH : Assurez-vous de pouvoir accéder à votre VPS via SSH.

3. Docker et Docker Compose : Assurez-vous que Docker et Docker Compose sont installés sur votre VPS. Vous pouvez les installer en utilisant les commandes suivantes :

   sudo apt update
   sudo apt install -y docker.io docker-compose

Étape 1 : Configurer l’environnement HedgeDoc

1. Créez un répertoire pour HedgeDoc :

   mkdir ~/hedgedoc
   cd ~/hedgedoc

2. Créez un fichier docker-compose.yml dans le répertoire hedgedoc. Ajoutez la configuration suivante pour configurer HedgeDoc avec PostgreSQL comme base de données :

   version: '3.1'
   
   services:
     hedgedoc:
       image: hedgedoc/hedgedoc:latest
       environment:
         - CMD_URI=https://your-domain.com
         - DB_TYPE=postgres
         - DB_HOST=db
         - DB_PORT=5432
         - DB_USER=hedgedoc
         - DB_PASS=hedgedoc_password
         - DB_NAME=hedgedoc
       ports:
         - '3000:3000'
       depends_on:
         - db
   
     db:
       image: postgres:latest
       environment:
         - POSTGRES_USER=hedgedoc
         - POSTGRES_PASSWORD=hedgedoc_password
         - POSTGRES_DB=hedgedoc
       volumes:
         - db_data:/var/lib/postgresql/data
   
   volumes:
     db_data:

3. Remplacez your-domain.com par le véritable domaine que vous utiliserez pour accéder à HedgeDoc.

Étape 2 : Exécution de HedgeDoc

1. Lancez l’application HedgeDoc à l’aide de Docker Compose :

   docker-compose up -d

2. Vérifiez que HedgeDoc fonctionne correctement en vérifiant les logs :

   docker-compose logs -f

3. Par défaut, HedgeDoc sera accessible à http://your-server-ip:3000. Vous voudrez configurer un proxy inverse pour un environnement de production.

Étape 3 : Configurer un Proxy Inverse avec Nginx

1. Installez Nginx :

   sudo apt install -y nginx

2. Créez un nouveau fichier de configuration pour HedgeDoc :

   sudo nano /etc/nginx/sites-available/hedgedoc

3. Ajoutez la configuration suivante :

   server {
       listen 80;
       server_name your-domain.com;
   
       location / {
           proxy_pass http://localhost:3000;
           proxy_set_header Host $host;
           proxy_set_header X-Real-IP $remote_addr;
           proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
           proxy_set_header X-Forwarded-Proto $scheme;
       }
   }

4. Activez la configuration :

   sudo ln -s /etc/nginx/sites-available/hedgedoc /etc/nginx/sites-enabled/
   sudo nginx -t
   sudo systemctl restart nginx

Étape 4 : Sécuriser HedgeDoc avec SSL

1. Pour sécuriser votre instance HedgeDoc, vous pouvez utiliser Let’s Encrypt. Installez Certbot :

   sudo apt install -y certbot python3-certbot-nginx

2. Exécutez Certbot pour obtenir un SSL pour votre domaine :

   sudo certbot --nginx -d your-domain.com

Questions Fréquemment Posées

1. Quels sont les avantages de l’auto-hébergement de HedgeDoc ?

L’auto-hébergement de HedgeDoc vous accorde un contrôle sans précédent sur vos données et votre vie privée. Contrairement aux options basées sur le cloud, lorsque vous auto-hébergez, vous gérez les mises à jour de sécurité et les personnalisations selon vos besoins. Cette configuration est cruciale pour les développeurs et les utilisateurs de laboratoires domestiques qui nécessitent la conformité avec des processus de gestion des données spécifiques ou qui souhaitent intégrer HedgeDoc dans des systèmes plus vastes de manière transparente.

2. Puis-je exécuter HedgeDoc sur un VPS peu puissant ?

Oui, HedgeDoc peut fonctionner efficacement sur un VPS peu puissant, à condition qu’il réponde aux exigences système. Pour les opérations de base, un VPS avec 2 Go de RAM et un espace disque minimal suffit. Cependant, pour des instances plus grandes ou des collaborations avec plusieurs utilisateurs, envisagez un VPS avec au moins 4 Go de RAM et 50 Go d’espace disque pour garantir des performances fluides. La structure tarifaire de fournisseurs comme Contabo et Hetzner peut répondre à ce besoin de manière abordable.

3. Comment mettre à jour mon installation HedgeDoc ?

Mettre à jour HedgeDoc est simple grâce à sa configuration Docker. Vous pouvez récupérer la dernière image et redémarrer les conteneurs. Voici la commande à exécuter :

docker-compose pull
docker-compose up -d

Après avoir exécuté ces commandes, vous devriez régulièrement consulter les notes de version de HedgeDoc pour tout changement ou étapes de migration requises pour assurer un fonctionnement fluide. Vous pouvez consulter la documentation de HedgeDoc pour des détails spécifiques sur les mises à jour de version.

Conclusion

Auto-héberger HedgeDoc sur un VPS vous permet de bénéficier d’un éditeur markdown puissant tout en conservant le contrôle sur votre environnement. Avec les étapes d’installation, de configuration et de sécurité décrites ci-dessus, vous devriez maintenant être en mesure d’installer, configurer et protéger HedgeDoc efficacement. Profitez de la collaboration en temps réel sans compromettre la vie privée ou l’intégrité des données.