Etherpad

Un éditeur de documents collaboratif moderne fonctionnant en temps réel.

Access Etherpad

  • User interface: https://<SERVER_IP>
  • Admin interface: https://<SERVER_IP>/admin
  • Admin credentials: Username admin, password stored in .env comme ADMIN_PASSWORD

Add Users via Admin Settings

1. Visit: https://<SERVER_IP>/admin

2. Go to Settings.

3. A JSON configuration file will be displayed.

4. Locate the users section:

  "users": {
    "admin": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "${ADMIN_PASSWORD:null}",
      "is_admin": true
    },
    "user": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "test",
      "is_admin": false
    }
  },

5. Add a new user (follow valid JSON syntax):

  "users": {
    "admin": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "${ADMIN_PASSWORD:null}",
      "is_admin": true
    },
    "user": {
      // 1) "password" can be replaced with "hash" if you install ep_hash_auth
      // 2) please note that if password is null, the user will not be created
      "password": "test",
      "is_admin": false
    },
    "newuser": {
      "password": "strongpassword",
      "is_admin": false
    }
  },

6. Click Save Settings.

7. Click Restart Etherpad.

Fichiers et répertoires importants

  • Installation de l'application : /root/etherpad
  • Fichier Docker Compose : /root/etherpad/docker-compose.yml
  • Variables d'environnement : /root/etherpad/.env
  • PostgreSQL database data: /var/lib/docker/volumes/etherpad_postgres_data/_data
  • Etherpad runtime data: /var/lib/docker/volumes/etherpad_etherpad-var/_data
  • Plugins directory: /var/lib/docker/volumes/etherpad_plugins/_data
  • Configuration Nginx : /etc/nginx/sites-available/etherpad
  • Certificats SSL : /etc/nginx/ssl/

Gestion des services

Liste des conteneurs :

docker ps

Redémarrer les conteneurs :

docker compose -f /root/etherpad/docker-compose.yml restart

Follow Etherpad logs:

docker compose -f /root/etherpad/docker-compose.yml logs -f

Redémarrer Nginx :

systemctl restart nginx

Activation du protocole SSL avec un domaine

1. Pointez votre domaine vers l'adresse IP du serveur.

2. Modifiez la configuration Nginx et remplacez les deux server_name <IP>; avec votre domaine (<your-domain>) pour les blocs HTTP (port 80) et HTTPS (port 443) :

vim /etc/nginx/sites-available/etherpad

3. Installez Certbot :

apt install -y certbot python3-certbot-nginx

4. Exécutez la commande suivante pour générer un certificat Let’s Encrypt valide :

certbot certonly --nginx --non-interactive --agree-tos --email [email protected] -d yourdomain.com

5. Remplacer les chemins SSL dans la configuration Nginx :

vim /etc/apache2/sites-available/etherpad
# Before:
    # ssl_certificate /etc/nginx/ssl/fullchain.pem;
    # ssl_certificate_key /etc/nginx/ssl/privkey.pem;
# After:
    # ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem;
    # ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem;

6. Redémarrez Nginx pour appliquer les modifications :

systemctl restart nginx

7. Ouvrez votre navigateur et rendez-vous sur : https://yourdomain.com

Remarques

  • Etherpad is served behind an Nginx reverse proxy for SSL termination and improved security.
  • A self-signed certificate may trigger browser warnings; this is expected unless Let’s Encrypt is used.
  • Some browsers may display errors or cause Etherpad to function incorrectly.
  • Etherpad has been tested and confirmed working on Firefox, which is recommended for best compatibility.

Détails de la demande