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.

Wichtige Dateien und Verzeichnisse

Application installation: /root/etherpad
Docker Compose-Datei: /root/etherpad/docker-compose.yml
Umgebungsvariablen: /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
Nginx-Konfiguration: /etc/nginx/sites-available/etherpad
SSL-Zertifikate: /etc/nginx/ssl/

Dienstleistungsmanagement

Container auflisten:

docker ps

Container neu starten:

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

Follow Etherpad logs:

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

Nginx neu starten:

systemctl restart nginx

SSL mit einer Domain aktivieren

1. Richten Sie Ihre Domain auf die Server-IP aus.

2. Bearbeiten Sie die Nginx-Konfiguration und ersetzen Sie beide server_name <IP>; mit Ihrer Domain (<your-domain>) sowohl für HTTP- (Port 80) als auch für HTTPS-Blöcke (Port 443):

vim /etc/nginx/sites-available/etherpad

3. Certbot installieren:

apt install -y certbot python3-certbot-nginx

4. Führen Sie den folgenden Befehl aus, um ein gültiges Let's Encrypt-Zertifikat zu generieren:

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

5. Ersetzen Sie die SSL-Pfade in der Nginx-Konfiguration:

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. Starten Sie Nginx neu, um die Änderungen zu übernehmen:

systemctl restart nginx

7. Öffnen Sie Ihren Browser und besuchen Sie: https://yourdomain.com

Anmerkungen

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.

Etherpad

Anwendungsdetails