So installieren Sie den Etherpad-Kollaborationseditor auf Ubuntu 24.04 Server

Etherpad ist ein Open-Source-Kollaborations- und Echtzeit-Texteditor für Ihr Team, der von überall und jederzeit zugänglich ist, da Etherpad ein webbasierter Texteditor ist. Etherpad unterstützt Versionierung und integrierte Formatierung für Teams und bietet einen hochgradig anpassbaren Editor mit der Unterstützung verschiedener Plugins. Es unterstützt auch moderne Dokumentformate wie doc, pdf, odt, markdown usw.

In diesem Leitfaden führen wir Sie durch den Installationsprozess des Etherpad-Kollaborationseditors auf dem Ubuntu 24.04-Server. Sie richten Etherpad mit dem MariaDB-Datenbankserver, Nginx als Reverse-Proxy ein und sichern dann Etherpad mit HTTPS über Certbot und Letsencrypt.

Voraussetzungen

Um mit diesem Leitfaden zu beginnen, stellen Sie sicher, dass Sie Folgendes haben:

Ein Ubuntu 24.04-Server.
Ein Nicht-Root-Benutzer mit Administratorrechten.
Einen Domainnamen, der auf eine Server-IP-Adresse zeigt.

Abhängigkeiten installieren

Etherpad ist ein kollaborativer Echtzeit-Editor, der in Node.js geschrieben ist. Um ihn zu installieren, müssen Sie Paketabhängigkeiten wie Node.js, NPM und Git installieren. Etherpad benötigt auch Python3 und MySQL/MariaDB für die Datenbank.

Zuerst aktualisieren Sie Ihr Ubuntu-Repository mit folgendem:

sudo apt update

update repo

Jetzt installieren Sie die Abhängigkeiten für Etherpad mit dem folgenden Befehl. Mit diesem Befehl installieren Sie den MariaDB-Server, Nginx, Node.js, Python3, Git und einige wichtige Tools.

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

Tippen Sie Y, um die Installation zu bestätigen.

install deps

Nach der Installation überprüfen Sie die Dienste von MariaDB und Nginx, um sicherzustellen, dass beide Dienste laufen.

Überprüfen Sie den MariaDB-Dienst mit folgendem:

sudo systemctl is-enabled mariadb  
sudo systemctl status mariadb

Wie Sie unten sehen können, läuft der MariaDB-Dienst und wird beim Booten automatisch gestartet.

check mariadb

Überprüfen Sie nun den Nginx-Dienst mit dem folgenden Befehl. Sie sollten eine ähnliche Ausgabe erhalten, wenn der Nginx-Dienst läuft und aktiviert ist.

sudo systemctl is-enabled nginx  
sudo systemctl status nginx

check nginx

Zuletzt überprüfen Sie die Node.js-Version mit dem Befehl.

node -v

Stellen Sie sicher, dass Sie Node.js v18.x oder höher haben. Etherpad unterstützt Node.js v18 und höher.

MariaDB-Server einrichten

Nachdem Sie die Abhängigkeiten installiert haben, konfigurieren Sie den MariaDB-Server und erstellen eine neue Datenbank und einen Benutzer für Etherpad. Sie sichern MariaDB mit dem Dienstprogramm ‘mariadb-secure-installation’ und richten dann die Datenbank und den Benutzer über den MariaDB-Client ein.

Um Ihren MariaDB-Server zu sichern, führen Sie Folgendes aus:

sudo mariadb-secure-installation

Sie werden mit den Konfigurationen des MariaDB-Servers aufgefordert:

Die Standardinstallation von MariaDB kommt ohne Passwort, drücken Sie ENTER, wenn Sie nach dem Passwort gefragt werden.
Geben Sie jetzt Y ein, um das MariaDB-Root-Passwort einzurichten. Geben Sie dann das neue Passwort für MariaDB ein und wiederholen Sie das Passwort.
Geben Sie Y ein, um den anonymen Benutzer aus Ihrer MariaDB-Installation zu entfernen.
Geben Sie erneut Y ein, wenn Sie aufgefordert werden, das Remote-Login für den MariaDB-Root-Benutzer zu deaktivieren.
Geben Sie Y ein, um die Standarddatenbank ‘test’ aus Ihrer MariaDB zu entfernen.
Geben Sie schließlich Y ein, um die Tabellenprivilegien neu zu laden und die neuen Änderungen anzuwenden.

Nachdem Sie den MariaDB-Server gesichert und konfiguriert haben, erstellen Sie eine neue Datenbank und einen Benutzer für Etherpad.

Melden Sie sich mit folgendem Befehl am MariaDB-Server an. Geben Sie das MariaDB-Root-Passwort ein, wenn Sie dazu aufgefordert werden.

sudo mariadb -u root -p

Führen Sie als Nächstes die folgenden MariaDB-Abfragen aus, um eine neue Datenbank ‘ etherpad_db ‘, einen Benutzer ‘ etherpad ‘ mit dem Passwort ‘ StrongPasswordEtherpadDB ‘ zu erstellen. Sie können die folgenden Datenbankdetails mit Ihren Informationen anpassen.

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

Führen Sie jetzt die folgende Abfrage aus, um sicherzustellen, dass der Benutzer ‘ etherpad ‘ auf die Datenbank ‘ etherpad_db ‘ zugreifen kann.

SHOW GRANTS FOR etherpad@localhost;

Sie können unten sehen, dass der Benutzer ‘ etherpad ‘ mehrere Berechtigungen für die Datenbank ‘ etherpad_db ‘ hat.

Tippen Sie zuletzt quit, um den MariaDB-Server zu verlassen.

check db user

Etherpad Lite installieren

Nachdem Sie die Datenbank und den Benutzer erstellt haben, laden Sie den Etherpad-Quellcode herunter, installieren die Etherpad-Abhängigkeiten mit dem Installationsskript und konfigurieren dann die Etherpad-Installation mit dem MariaDB-Server.

Standardmäßig verwendet Etherpad den pnpm-Paketmanager zur Verwaltung der Installation, daher müssen Sie zuerst ‘pnpm’ global auf Ihrem System installieren.

Zuerst installieren Sie das pnpm-Paket global (-g) mit dem folgenden npm-Befehl. Standardmäßig verwendet das Etherpad-Projekt pnpm als Node.js-Paketmanager anstelle von standard-npm.

npm install pnpm -g

Führen Sie jetzt den folgenden Befehl aus, um einen neuen Systembenutzer ‘ etherpad ‘ zu erstellen. Dieser Benutzer wird verwendet, um die Etherpad-Anwendung auszuführen.

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

Gehen Sie als Nächstes zu /opt und laden Sie den Etherpad-Quellcode in das Verzeichnis ‘ etherpad-lite ‘ mit git herunter. Ändern Sie dann den Besitz des Verzeichnisses ‘ /opt/etherpad-lite ‘ auf den Benutzer ‘ etherpad ‘.

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

Danach gehen Sie in das Verzeichnis ‘opt/etherpad-lite’ und installieren die Node.js-Abhängigkeiten für Etherpad mit folgendem.

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

Unten sehen Sie den Downloadprozess für die Etherpad-Abhängigkeiten mit dem pnpm-Paketmanager.

dependencies installation

Nachdem die Abhängigkeiten installiert sind, sollte Etherpad automatisch laufen. Sie können unten sehen, dass Etherpad 2.0.3 läuft.

Drücken Sie Ctrl+c, um den aktuellen Etherpad-Prozess zu beenden. Sie werden Etherpad mit der MariaDB-Datenbank konfigurieren.

running etherpad

Öffnen Sie jetzt die Datei ‘ settings.json ‘ mit dem folgenden Nano-Editor.

nano settings.json

Ändern Sie den Titel Ihrer Etherpad-Installation.

 "title": "Etherpad Ubuntu 24",

Ändern Sie die Standard-IP-Adresse auf 12.0.0.1 oder localhost. Dies wird den Etherpad-Prozess nur auf localhost starten.

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

Kommentieren Sie die Standardkonfiguration der ‘ dirty ‘ Datenbank wie folgt:

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

Fügen Sie die folgende Konfiguration ein, um eine Datenbank mit dem MariaDB-Server einzurichten. Stellen Sie sicher, dass Sie die Details der Datenbankinformationen mit Ihren ändern.

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

Wenn Sie fertig sind, speichern Sie die Datei und beenden den Editor.

Etherpad als systemd-Dienst ausführen

Jetzt, da Sie Etherpad installiert und konfiguriert haben, erstellen Sie eine neue systemd-Dienstdatei für Etherpad. Damit können Sie Etherpad im Hintergrund ausführen und Etherpad über den Befehl ‘systemctl’ verwalten.

Erstellen Sie eine neue systemd-Dienstdatei für Etherpad ‘ /etc/systemd/system/etherpad.service ‘ mit dem Nano-Editor.

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

Fügen Sie die folgende Konfiguration in die Datei ein. Damit führen Sie Etherpad im Hintergrund als systemd-Dienst über den Befehl ‘pnpm’ aus.

[Unit]  
Description=Etherpad-lite, der kollaborative Editor.  
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  
# verwenden Sie mysql plus eine vollständige settings.json, um die Service-Hold-off-Zeit zu vermeiden, planen Sie einen Neustart.  
Restart=always  
  
[Install]  
WantedBy=multi-user.target

Speichern Sie die Datei und beenden Sie.

Führen Sie jetzt den folgenden Befehl aus, um den systemd-Manager neu zu laden und die Etherpad-Dienstdatei anzuwenden.

sudo systemctl daemon-reload

Nachdem systemd neu geladen wurde, starten Sie den ‘etherpad’-Dienst und aktivieren Sie ihn mit dem folgenden systemctl-Befehl.

sudo systemctl start etherpad  
sudo systemctl enable etherpad

Führen Sie als Nächstes den folgenden Befehl aus, um den Status des Etherpad-Dienstes zu überprüfen und sicherzustellen, dass der Dienst läuft.

sudo systemctl status etherpad

Sie können unten sehen, dass der Etherpad-Dienst als Dienst läuft.

Überprüfen Sie zuletzt den Standard-Etherpad-Port 9001 mit dem folgenden ‘ss’-Befehl. Sie sollten sehen, dass Port 9001 vom Etherpad-Prozess verwendet wird.

ss -tulpn | grep 9001

Nginx als Reverse-Proxy einrichten

Sie werden Etherpad in diesem Leitfaden mit Nginx als Reverse-Proxy ausführen. Jetzt erstellen Sie die Nginx-Serverblockkonfiguration für Etherpad und stellen sicher, dass Sie Ihren Domainnamen für Etherpad vorbereitet haben.

Verwenden Sie den folgenden Nano-Editor-Befehl, um einen neuen Nginx-Serverblock ‘/etc/nginx/sites-available/etherpad.conf’ zu erstellen.

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

Fügen Sie die folgende Konfiguration hinzu und ändern Sie die Option server_name mit Ihrem Domainnamen. Mit dieser Konfiguration verwenden Sie Nginx als Reverse-Proxy für Etherpad, das auf Port 9001 läuft.

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; # seien Sie vorsichtig, diese Zeile überschreibt keine in einer conf.d/file.conf festgelegte proxy_buffering on  
 proxy_set_header Host $host;  
 proxy_pass_header Server;  
# Hinweis: Sie möchten möglicherweise auch diese Header usw. weitergeben.  
 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-Protokolle zeigen die tatsächliche Remote-IP  
 proxy_set_header X-Forwarded-Proto $scheme; # für EP, um das sichere Cookie-Flag zu setzen, wenn https verwendet wird  
 proxy_http_version 1.1; # empfohlen bei Keepalive-Verbindungen  
# WebSocket-Proxying - von https://nginx.org/en/docs/http/websocket.html  
 proxy_set_header Upgrade $http_upgrade;  
 proxy_set_header Connection "upgrade";  
 }  
  
}

Speichern Sie die Datei und schließen Sie sie, wenn Sie fertig sind.

Führen Sie jetzt den folgenden Befehl aus, um die Serverblockdatei ‘ etherpad.conf ‘ zu aktivieren und Ihre Nginx-Syntax zu überprüfen.

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

Sie sollten eine Ausgabe ‘ nginx ist ok…Test erfolgreich ‘ mit der richtigen Nginx-Syntax erhalten.

Führen Sie zuletzt den folgenden Befehl aus, um den Nginx-Dienst neu zu starten und Ihren neuen Serverblock anzuwenden. Nach der Ausführung des Befehls ist Ihr Etherpad über den Nginx-Webserver zugänglich.

sudo systemctl restart nginx

Etherpad mit HTTPS sichern

Nachdem Sie den Nginx-Reverse-Proxy konfiguriert haben, sichern Sie Etherpad mit HTTPS. Wenn Sie die öffentliche Domain verwenden, können Sie die folgenden Schritte ausführen, um HTTPS mit Certbot und Letsencrypt einzurichten. Benutzer lokaler Domains können selbstsignierte Zertifikate verwenden.

Installieren Sie Certbot und das Certbot-Nginx-Plugin mit dem folgenden Befehl. Wenn Sie dazu aufgefordert werden, tippen Sie Y, um die Installation zu bestätigen.

sudo apt install certbot python3-certbot-nginx

Führen Sie jetzt den folgenden Certbot-Befehl aus, um SSL/TLS-Zertifikate von Letsencrypt zu generieren. Stellen Sie sicher, dass Sie den Domainnamen und die E-Mail-Adresse mit Ihren Angaben ändern.

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

Nachdem der Vorgang abgeschlossen ist, sind Ihre Zertifikate im Verzeichnis ‘ /etc/letsencrypt/live/domain.com ‘ verfügbar. Außerdem sollte Ihre Etherpad-Installation automatisch mit HTTPS über das Certbot-Nginx-Plugin ausgeführt werden.

Etherpad aufrufen

Besuchen Sie Ihren Etherpad-Domainnamen https://etherpad.howtoforge.local, um auf Ihre Etherpad-Installation zuzugreifen. Wenn dies erfolgreich ist, erhalten Sie die folgende Seite:

Geben Sie den neuen Namen für Ihr erstes Pad ein und klicken Sie auf OK, um zu bestätigen.

create pad

Jetzt sehen Sie den Dokumenteneditor für Etherpad. Sie können das Dokument jetzt gleichzeitig mit Ihren Freunden oder Kollegen bearbeiten.

etherpad editor

Fazit

Herzlichen Glückwunsch! Sie haben den Etherpad-Kollaborationseditor auf dem Ubuntu 24.04-Server installiert. Sie haben Etherpad mit dem MariaDB-Datenbankserver und dem Nginx-Webserver zum Laufen gebracht. Außerdem haben Sie Etherpad mit HTTPS über Certbot und Letsencrypt gesichert.