Etherpad

Access Etherpad

• User interface: https://<SERVER_IP>
• Admin interface: https://<SERVER_IP>/admin
• Admin credentials: Username admin, password stored in .env als 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.

Belangrijke bestanden en mappen

• Applicatie-installatie: /root/etherpad
• Docker Compose-bestand: /root/etherpad/docker-compose.yml
• Omgevingsvariabelen: /root/etherpad/.env
• PostgreSQL-databasegegevens: /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
• Nginx-configuratie: /etc/nginx/sites-available/etherpad
• SSL-certificaten: /etc/nginx/ssl/

Servicemanagement

Containers weergeven:

docker ps

Containers opnieuw opstarten:

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

Follow Etherpad logs:

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

Start Nginx opnieuw op:

systemctl restart nginx

SSL inschakelen met een domein

1. Wijs uw domein naar het IP-adres van de server.

2. Bewerk de Nginx-configuratie en vervang beide server_name <IP>; met uw domein (<your-domain>) voor zowel HTTP (poort 80) als HTTPS (poort 443) blokken:

vim /etc/nginx/sites-available/etherpad

3. Certbot installeren:

apt install -y certbot python3-certbot-nginx

4. Voer de volgende opdracht uit om een geldig Let’s Encrypt-certificaat te genereren:

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

5. Vervang SSL-paden in Nginx-configuratie:

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. Start Nginx opnieuw op om de wijzigingen toe te passen:

systemctl restart nginx

7. Open uw browser en ga naar: https://yourdomain.com

Opmerkingen

• 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.