Comment installer l'éditeur de collaboration Etherpad sur le serveur Ubuntu 24.04

Etherpad est un éditeur de texte collaboratif et en temps réel open-source pour votre équipe, accessible de n’importe où à tout moment car Etherpad est un éditeur de texte basé sur le web. Etherpad prend en charge la gestion des versions et le formatage intégré pour les équipes et offre un éditeur hautement personnalisable avec le support de divers plugins. Il prend également en charge des formats de document modernes tels que doc, pdf, odt, markdown, etc.

Dans ce guide, nous vous guiderons à travers le processus d’installation de l’éditeur de collaboration Etherpad sur le serveur Ubuntu 24.04. Vous configurerez Etherpad avec le serveur de base de données MariaDB, Nginx comme proxy inverse, puis sécuriserez Etherpad avec HTTPS via Certbot et Letsencrypt.

Prérequis

Pour commencer ce guide, assurez-vous d’avoir les éléments suivants :

Un serveur Ubuntu 24.04.
Un utilisateur non-root avec des privilèges d’administrateur.
Un nom de domaine pointant vers une adresse IP de serveur.

Installation des dépendances

Etherpad est un éditeur collaboratif en temps réel écrit en Node.js. Pour l’installer, vous devez installer des dépendances de package telles que Node.js, NPM et Git. Etherpad nécessite également Python3 et MySQL/MariaDB pour la base de données.

Tout d’abord, mettez à jour votre dépôt Ubuntu avec ce qui suit :

sudo apt update

update repo

Maintenant, installez les dépendances pour Etherpad en utilisant la commande ci-dessous. Avec cette commande, vous installerez le serveur MariaDB, Nginx, Node.js, Python3, Git et quelques outils essentiels.

sudo apt install mariadb-server nginx nodejs npm gzip git curl python3 libssl-dev

Tapez Y pour confirmer l’installation.

install deps

Après l’installation, vérifiez les services MariaDB et Nginx pour vous assurer que les deux services fonctionnent.

Vérifiez le service MariaDB avec ce qui suit :

sudo systemctl is-enabled mariadb  
sudo systemctl status mariadb

Comme vous pouvez le voir ci-dessous, le service MariaDB fonctionne et démarrera automatiquement au démarrage.

check mariadb

Maintenant, vérifiez le service Nginx en utilisant la commande ci-dessous. Vous devriez obtenir une sortie similaire lorsque le service Nginx fonctionne et est activé.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

check nginx

Enfin, vérifiez la version de Node.js avec la commande.

node -v

Assurez-vous d’avoir Node.js v18.x ou plus. Etherpad prend en charge Node.js v18 et supérieur.

Configuration du serveur MariaDB

Après avoir installé les dépendances, vous allez configurer le serveur MariaDB et créer une nouvelle base de données et un utilisateur pour Etherpad. Vous sécuriserez MariaDB en utilisant l’utilitaire ‘mariadb-secure-installation’, puis configurerez la base de données et l’utilisateur via le client MariaDB.

Pour sécuriser votre serveur MariaDB, exécutez ce qui suit :

sudo mariadb-secure-installation

Vous serez invité à configurer le serveur MariaDB :

L’installation par défaut de MariaDB ne comporte pas de mot de passe, appuyez sur ENTER lorsque vous êtes invité à entrer le mot de passe.
Maintenant, saisissez Y pour configurer le mot de passe root de MariaDB. Ensuite, tapez le nouveau mot de passe pour MariaDB et répétez le mot de passe.
Saisissez Y pour supprimer l’utilisateur anonyme de votre installation MariaDB.
Saisissez Y à nouveau lorsque vous êtes invité à désactiver la connexion à distance pour l’utilisateur root de MariaDB.
Saisissez Y pour supprimer la base de données par défaut test de votre MariaDB.
Enfin, saisissez Y pour recharger les privilèges des tables et appliquer les nouvelles modifications.

Après avoir sécurisé et configuré le serveur MariaDB, vous allez créer une nouvelle base de données et un utilisateur pour Etherpad.

Connectez-vous au serveur MariaDB avec la commande suivante. Saisissez le mot de passe root de MariaDB lorsque vous y êtes invité.

sudo mariadb -u root -p

Ensuite, exécutez les requêtes MariaDB suivantes pour créer une nouvelle base de données ‘etherpad_db‘, un utilisateur ‘etherpad‘, avec le mot de passe ‘StrongPasswordEtherpadDB‘. Vous pouvez ajuster les détails de la base de données suivants avec vos informations.

CREATE DATABASE etherpad_db;  
CREATE USER etherpad@localhost IDENTIFIED BY 'StrongPasswordEtherpadDB';  
GRANT CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on etherpad_db.* to etherpad@localhost;  
FLUSH PRIVILEGES;

create database and user

Maintenant, exécutez la requête suivante pour vous assurer que l’utilisateur ‘etherpad‘ peut accéder à la base de données ‘etherpad_db‘.

SHOW GRANTS FOR etherpad@localhost;

Vous pouvez voir ci-dessous que l’utilisateur ‘etherpad‘ a plusieurs privilèges sur la base de données ‘etherpad_db‘.

Enfin, tapez quit pour quitter le serveur MariaDB.

check db user

Installation d’Etherpad Lite

Après avoir créé la base de données et l’utilisateur, vous allez télécharger le code source d’Etherpad, installer les dépendances d’Etherpad avec le script d’installation, puis configurer l’installation d’Etherpad avec le serveur MariaDB.

Par défaut, Etherpad utilise le gestionnaire de packages pnpm pour gérer l’installation, vous devez donc d’abord installer ‘pnpm’ globalement sur votre système.

Tout d’abord, installez le package pnpm globalement (-g) en utilisant la commande npm suivante. Par défaut, le projet Etherpad utilise pnpm comme gestionnaire de packages Node.js au lieu de npm standard.

npm install pnpm -g

Maintenant, exécutez la commande ci-dessous pour créer un nouvel utilisateur système ‘etherpad‘. Cet utilisateur sera utilisé pour exécuter l’application Etherpad.

sudo adduser --system --no-create-home --home=/opt/etherpad-lite --group etherpad

Ensuite, allez dans /opt et téléchargez le code source d’Etherpad dans le répertoire ‘etherpad-lite‘ avec git. Ensuite, changez la propriété du répertoire ‘/opt/etherpad-lite‘ à l’utilisateur ‘etherpad‘.

cd /opt && git clone --branch master https://github.com/ether/etherpad-lite.git   
sudo chown -R etherpad:etherpad /opt/etherpad-lite

Après cela, allez dans le répertoire ‘opt/etherpad-lite’ et installez les dépendances Node.js pour Etherpad avec ce qui suit.

cd /opt/etherpad-lite  
sudo su -s /bin/bash -c "./bin/run.sh" etherpad

Voici le processus de téléchargement des dépendances d’Etherpad en utilisant le gestionnaire de packages pnpm.

dependencies installation

Après l’installation des dépendances, Etherpad devrait fonctionner automatiquement. Vous pouvez voir ci-dessous qu’Etherpad 2.0.3 fonctionne.

Appuyez sur Ctrl+c pour terminer le processus actuel d’Etherpad. Vous allez configurer Etherpad avec la base de données MariaDB.

running etherpad

Maintenant, ouvrez le fichier ‘settings.json‘ avec l’éditeur nano suivant.

nano settings.json

Changez le titre de votre installation Etherpad.

 "title": "Etherpad Ubuntu 24",

Changez l’adresse IP par défaut en 12.0.0.1 ou localhost. Cela démarrera le processus Etherpad uniquement en localhost.

"ip": "127.0.0.1",  
 "port": 9001,

Commentez la configuration de la base de données par défaut ‘dirty‘ comme suit :

 /*  
 *"dbType": "dirty",  
 *"dbSettings": {  
 * "filename": "var/dirty.db"  
 *},  
 */

Insérez la configuration ci-dessous pour configurer une base de données avec le serveur MariaDB. Assurez-vous de changer les détails des informations de la base de données avec les vôtres.

 "dbType" : "mysql",  
 "dbSettings" : {  
 "user": "etherpad",  
 "host": "127.0.0.1",  
 "port": 3306,  
 "password": "StrongPasswordEtherpadDB",  
 "database": "etherpad_db",  
 "charset": "utf8mb4"  
 },

Lorsque vous avez terminé, enregistrez le fichier et quittez l’éditeur.

Exécution d’Etherpad en tant que service systemd

Maintenant que vous avez installé et configuré Etherpad, vous allez créer un nouveau fichier de service systemd pour Etherpad. Avec cela, vous exécuterez Etherpad en arrière-plan, et vous pourrez gérer Etherpad via la commande ‘systemctl’.

Créez un nouveau fichier de service systemd pour Etherpad ‘/etc/systemd/system/etherpad.service‘ avec l’éditeur nano.

sudo nano /etc/systemd/system/etherpad.service

Ajoutez la configuration suivante au fichier. Avec cela, vous exécuterez Etherpad en arrière-plan en tant que service systemd via la commande ‘pnpm’.

[Unit]  
Description=Etherpad-lite, l'éditeur collaboratif.  
After=syslog.target network.target mariadb.service  
  
[Service]  
Type=simple  
User=etherpad  
Group=etherpad  
WorkingDirectory=/opt/etherpad-lite  
ExecStart=/usr/local/bin/pnpm run prod  
# utilisez mysql plus un settings.json complet pour éviter le temps d'attente du service, planifiant le redémarrage.  
Restart=always  
  
[Install]  
WantedBy=multi-user.target

Enregistrez le fichier et quittez.

Maintenant, exécutez la commande ci-dessous pour recharger le gestionnaire systemd et appliquer le fichier de service Etherpad.

sudo systemctl daemon-reload

Après le rechargement de systemd, démarrez et activez le service ‘etherpad’ avec la commande systemctl suivante.

sudo systemctl start etherpad  
sudo systemctl enable etherpad

Ensuite, exécutez la commande ci-dessous pour vérifier l’état du service Etherpad et vous assurer que le service fonctionne.

sudo systemctl status etherpad

Vous pouvez voir ci-dessous que le service Etherpad fonctionne en tant que service.

Enfin, vérifiez le port par défaut d’Etherpad 9001 avec la commande ‘ss’ ci-dessous. Vous devriez voir que le port 9001 est utilisé par le processus Etherpad.

ss -tulpn | grep 9001

Configuration de Nginx en tant que proxy inverse

Vous exécuterez Etherpad avec Nginx en tant que proxy inverse dans ce guide. Donc maintenant, vous allez créer la configuration du bloc de serveur Nginx pour Etherpad, et vous assurer que vous avez préparé votre nom de domaine pour Etherpad.

Utilisez la commande suivante de l’éditeur nano pour créer un nouveau bloc de serveur Nginx ‘/etc/nginx/sites-available/etherpad.conf’.

sudo nano /etc/nginx/sites-available/etherpad.conf

Ajoutez la configuration suivante et changez l’option server_name avec votre nom de domaine. Avec cette configuration, vous utiliserez Nginx comme proxy inverse pour Etherpad, qui fonctionne sur le port 9001.

server {  
 listen 80;  
 server_name etherpad.howtoforge.local;  
  
 access_log /var/log/nginx/eplite.access.log;  
 error_log /var/log/nginx/eplite.error.log;  
  
location / {  
 proxy_pass http://127.0.0.1:9001;  
 proxy_buffering off; # attention, cette ligne ne remplace pas le proxy_buffering on défini dans un conf.d/file.conf  
 proxy_set_header Host $host;  
 proxy_pass_header Server;  
# Notez que vous voudrez peut-être également passer ces en-têtes, etc.  
 proxy_set_header X-Real-IP $remote_addr; # https://nginx.org/en/docs/http/ngx_http_proxy_module.html  
 proxy_set_header X-Forwarded-For $remote_addr; # EP logs pour montrer l'adresse IP distante réelle  
 proxy_set_header X-Forwarded-Proto $scheme; # pour EP pour définir le drapeau de cookie sécurisé lorsque https est utilisé  
 proxy_http_version 1.1; # recommandé avec des connexions keepalive  
# Proxy WebSocket - de https://nginx.org/en/docs/http/websocket.html  
 proxy_set_header Upgrade $http_upgrade;  
 proxy_set_header Connection "upgrade";  
 }  
  
}

Enregistrez et fermez le fichier une fois terminé.

Maintenant, exécutez la commande ci-dessous pour activer le fichier de bloc de serveur ‘etherpad.conf‘ et vérifier votre syntaxe Nginx.

sudo ln -s /etc/nginx/sites-available/etherpad.conf /etc/nginx/sites-enabled/  
sudo nginx -t

Vous devriez obtenir une sortie ‘nginx is ok…test is successful‘ avec une syntaxe Nginx correcte.

Enfin, exécutez la commande ci-dessous pour redémarrer le service Nginx et appliquer votre nouveau bloc de serveur. Après avoir exécuté la commande, votre Etherpad est accessible via le serveur web Nginx.

sudo systemctl restart nginx

Sécurisation d’Etherpad avec HTTPS

Après avoir configuré le proxy inverse Nginx, vous allez sécuriser Etherpad avec HTTPS. Si vous utilisez le domaine public, vous pouvez utiliser les étapes suivantes pour configurer HTTPS avec Certbot et Letsencrypt. Les utilisateurs de domaine local peuvent utiliser des certificats auto-signés.

Installez Certbot et le plugin Certbot Nginx en utilisant la commande suivante. Lorsque vous y êtes invité, tapez Y pour confirmer l’installation.

sudo apt install certbot python3-certbot-nginx

Maintenant, exécutez la commande certbot suivante pour générer des certificats SSL/TLS de Letsencrypt. Assurez-vous de changer le nom de domaine et l’adresse e-mail avec vos détails.

sudo certbot --nginx --agree-tos --redirect --hsts --staple-ocsp --email [email protected] -d etherpad.howtoforge.local

Après avoir terminé le processus, vos certificats seront disponibles dans le répertoire ‘/etc/letsencrypt/live/domain.com‘. De plus, votre installation d’Etherpad devrait fonctionner automatiquement avec HTTPS via le plugin Certbot Nginx.

Accéder à Etherpad

Visitez votre nom de domaine Etherpad https://etherpad.howtoforge.local pour accéder à votre installation Etherpad. Si cela réussit, vous obtiendrez la page suivante :

Tapez le nouveau nom pour votre premier pad et cliquez sur OK pour confirmer.

create pad

Maintenant, vous verrez l’éditeur de documents pour Etherpad. Vous pouvez maintenant modifier le document en même temps que vos amis ou collègues.

etherpad editor

Conclusion

Félicitations ! Vous avez installé l’éditeur de collaboration Etherpad sur le serveur Ubuntu 24.04. Vous avez Etherpad fonctionnant avec le serveur de base de données MariaDB et le serveur web Nginx. De plus, vous avez sécurisé Etherpad avec HTTPS via Certbot et Letsencrypt.