Etherpad

Greife auf Etherpad zu

• Benutzeroberfläche: https://<SERVER_IP>
• Admin-Oberfläche: https://<SERVER_IP>/admin
• Administratoranmeldeinformationen: Benutzername admin, Passwort gespeichert in .env as ADMIN_PASSWORD

Füge Benutzer über die Admin-Einstellungen hinzu

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

2. Gehe zu Einstellungen.

3. Eine JSON-Konfigurationsdatei wird angezeigt.

4. Suche die users Abschnitt:

  "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. Füge einen neuen Benutzer hinzu (folge der gültigen 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. Klicke auf Einstellungen speichern.

7. Klicke auf Etherpad neu starten.

Wichtige Dateien und Verzeichnisse

• Anwendungsinstallation: /root/etherpad
• Docker Compose-Datei: /root/etherpad/docker-compose.yml
• Umgebungsvariablen: /root/etherpad/.env
• PostgreSQL-Datenbankdaten: /var/lib/docker/volumes/etherpad_postgres_data/_data
• Etherpad-Laufzeitdaten: /var/lib/docker/volumes/etherpad_etherpad-var/_data
• Plugins-Verzeichnis: /var/lib/docker/volumes/etherpad_plugins/_data
• Nginx-Konfiguration: /etc/nginx/sites-available/etherpad
• SSL-Zertifikate: /etc/nginx/ssl/

Service-Management

Container auflisten:

docker ps

Container neu starten:

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

Folge den Etherpad-Protokollen:

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

Starte Nginx neu:

systemctl restart nginx

SSL mit einer Domain aktivieren

1. Richte deine Domain auf die Server-IP aus.

2. Nginx-Konfiguration bearbeiten und beide ersetzen server_name <IP>; mit deiner Domain (<your-domain>) für beide Blöcke HTTP (Port 80) und HTTPS (Port 443):

vim /etc/nginx/sites-available/etherpad

3. Certbot installieren:

apt install -y certbot python3-certbot-nginx

4. Führe folgenden Befehl aus, um ein gültiges Let’s Encrypt-Zertifikat zu erzeugen:

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

5. SSL-Pfade in der Nginx-Konfiguration ersetzen:

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. Nginx neu starten, um die Änderungen anzuwenden:

systemctl restart nginx

7. Öffne deinen Browser und besuche: https://yourdomain.com

Notizen

• Etherpad wird hinter einem Nginx-Reverse-Proxy für SSL-Terminierung und verbesserte Sicherheit bereitgestellt.
• Ein selbstsigniertes Zertifikat kann Browserwarnungen auslösen; Dies ist zu erwarten, es sei denn, Let’s Encrypt wird verwendet.
• Einige Browser zeigen möglicherweise Fehler an oder führen dazu, dass Etherpad nicht richtig funktioniert.
• Etherpad wurde getestet und bestätigt, dass es mit Firefox funktioniert, was für beste Kompatibilität empfohlen wird.