So installierst du den Etherpad Collaborative Web Editor unter AlmaLinux
Etherpad ist eine kostenlose, quelloffene, webbasierte Bearbeitungsanwendung, mit der du ein Dokument über den Webbrowser bearbeiten kannst. Es ähnelt einem Multiplayer-Editor, mit dem du gemeinsam mit deinen Freunden, Kommilitonen oder Kollegen Artikel, Pressemitteilungen, Aufgabenlisten usw. schreiben kannst, wobei alle gleichzeitig an demselben Dokument arbeiten. Es bietet eine Reihe von Plugins, mit denen du die Etherpad-Instanz an deine Bedürfnisse anpassen kannst.
Dieser Beitrag zeigt dir, wie du Etherpad mit Nginx und Let’s Encrypt SSL auf Alma Linux 8 installierst.
Voraussetzungen
- Ein Server, auf dem Alma Linux 8 läuft.
- Ein gültiger Domainname, der auf die IP deines Servers zeigt.
- Ein Root-Passwort ist auf deinem Server konfiguriert.
MariaDB-Datenbank installieren und konfigurieren
Etherpad verwendet MariaDB als Datenbank-Backend. Daher muss der MariaDB-Datenbankserver auf deinem Server installiert werden. Du kannst den MariaDB-Server installieren, indem du den folgenden Befehl ausführst:
dnf install mariadb-server -y
Sobald MariaDB installiert ist, starte und aktiviere den MariaDB-Dienst mit dem folgenden Befehl:
systemctl start mariadb systemctl enable mariadb
Als Nächstes sicherst du die MariaDB-Installation und legst das MariaDB-Root-Passwort mit dem folgenden Befehl fest:
mysql_secure_installation
Beantworte alle Fragen wie unten gezeigt:
Enter current password for root (enter for none): Switch to unix_socket authentication [Y/n] Y Change the root password? [Y/n] Y Remove anonymous users? [Y/n] Y Disallow root login remotely? [Y/n] Y Remove test database and access to it? [Y/n] Y Reload privilege tables now? [Y/n] Y
Sobald die MariaDB gesichert ist, melde dich mit folgendem Befehl bei MariaDB an:
mysql -u root -p
Sobald du eingeloggt bist, erstelle eine Datenbank und einen Benutzer mit dem folgenden Befehl:
MariaDB [(none)]> CREATE DATABASE etherpad; MariaDB [(none)]> CREATE USER 'etherpad'@'localhost' identified by 'password';
Als Nächstes erteilst du der Etherpad-Datenbank mit dem folgenden Befehl alle Berechtigungen:
MariaDB [(none)]> GRANT CREATE,ALTER,SELECT,INSERT,UPDATE,DELETE on etherpad.* to 'etherpad'@'localhost';
Lösche die Berechtigungen und verlasse die MariaDB-Shell mit folgendem Befehl:
MariaDB [(none)]> FLUSH PRIVILEGES; MariaDB [(none)]> EXIT;
Wenn du damit fertig bist, kannst du mit dem nächsten Schritt fortfahren.
Node.js installieren
Als Nächstes musst du auch Node.js auf deinem Server installieren. Du kannst es mit dem folgenden Befehl installieren:
curl -fsSL https://rpm.nodesource.com/setup_16.x | bash - dnf install nodejs -y
Überprüfe die Node.js-Installation mit folgendem Befehl:
node --version
Du solltest die folgende Ausgabe sehen:
v16.13.1
Etherpad auf Alma Linux 8 installieren
Erstelle zunächst mit dem folgenden Befehl einen eigenen Benutzer für Etherpad:
adduser --system --home /opt/etherpad --create-home --user-group etherpad
Als nächstes installierst du das Git-Paket mit dem folgenden Befehl:
dnf install git -y
Melde dich mit dem Benutzer Etherpad an und lade die neueste Version von Etherpad mit dem folgenden Befehl herunter:
su - etherpad git clone --branch master git://github.com/ether/etherpad-lite.git
Wechsle dann in das heruntergeladene Verzeichnis und starte Etherpad mit folgendem Befehl:
cd etherpad-lite ./src/bin/run.sh
Wenn alles in Ordnung ist, erhältst du die folgende Ausgabe:
[2022-01-07 08:40:10.167] [INFO] APIHandler - Api key file "/opt/etherpad/etherpad-lite/APIKEY.txt" not found. Creating with random contents. [2022-01-07 08:40:10.235] [INFO] server - Installed plugins: [2022-01-07 08:40:10.246] [INFO] console - Report bugs at https://github.com/ether/etherpad-lite/issues [2022-01-07 08:40:10.247] [INFO] console - Your Etherpad version is 1.8.16 (142a47c) [2022-01-07 08:40:11.840] [INFO] http - HTTP server listening for connections [2022-01-07 08:40:11.841] [INFO] console - You can access your Etherpad instance at http://0.0.0.0:9001/ [2022-01-07 08:40:11.841] [WARN] console - Admin username and password not set in settings.json. To access admin please uncomment and edit "users" in settings.json [2022-01-07 08:40:11.841] [WARN] console - Etherpad is running in Development mode. This mode is slower for users and less secure than production mode. You should set the NODE_ENV environment variable to production by using: export NODE_ENV=production [2022-01-07 08:40:11.841] [INFO] server - Etherpad is running
Drücke STRG+C, um Etherpad zu beenden. Wir werden Etherpad später so konfigurieren, dass es als Daemon läuft.
Als Nächstes bearbeitest du die Datei settings.json und definierst deine Datenbank- und Proxy-Einstellungen:
nano settings.json
Entferne die folgenden Zeilen:
"dbType": "dirty",
"dbSettings": {
"filename": "var/dirty.db"
},
Ändere als nächstes die folgenden Zeilen:
"dbType" : "mysql",
"dbSettings" : {
"user": "etherpad",
"host": "localhost",
"port": 3306,
"password": "password",
"database": "etherpad",
"charset": "utf8mb4"
},
"trustProxy": true,
Speichere und schließe die Datei und beende den Etherpad-Benutzer mit dem folgenden Befehl:
exit
Erstelle eine Systemd-Dienstdatei für Etherpad
Als Nächstes musst du eine systemd-Dienstdatei erstellen, um das Etherpad zu verwalten. Du kannst sie mit dem folgenden Befehl erstellen:
nano /etc/systemd/system/etherpad.service
Füge die folgenden Zeilen ein:
[Unit] Description=Etherpad, a collaborative web editor. After=syslog.target network.target [Service] Type=simple User=etherpad Group=etherpad WorkingDirectory=/opt/etherpad Environment=NODE_ENV=production ExecStart=/usr/bin/node --experimental-worker /opt/etherpad/etherpad-lite/node_modules/ep_etherpad-lite/node/server.js Restart=always [Install] WantedBy=multi-user.target
Speichere und schließe die Datei und lade systemd neu, um die Änderungen zu übernehmen:
systemctl daemon-reload
Als Nächstes startest und aktivierst du den Etherpad-Dienst mit dem folgenden Befehl:
systemctl enable etherpad --now
Jetzt kannst du den Status des Etherpads mit dem folgenden Befehl überprüfen:
systemctl status etherpad
Du erhältst die folgende Ausgabe:
? etherpad.service - Etherpad, a collaborative web editor.
Loaded: loaded (/etc/systemd/system/etherpad.service; enabled; vendor preset: disabled)
Active: active (running) since Fri 2022-01-07 08:42:28 UTC; 5s ago
Main PID: 10174 (node)
Tasks: 13 (limit: 11411)
Memory: 110.4M
CGroup: /system.slice/etherpad.service
??10174 /usr/bin/node --experimental-worker /opt/etherpad/etherpad-lite/node_modules/ep_etherpad-lite/node/server.js
Jan 07 08:42:28 linux node[10174]: [2022-01-07 08:42:28.641] [INFO] settings - Random string used for versioning assets: dacd04e4
Jan 07 08:42:28 linux node[10174]: [2022-01-07 08:42:28.891] [INFO] server - Starting Etherpad...
Jan 07 08:42:28 linux node[10174]: [2022-01-07 08:42:28.967] [INFO] plugins - Running npm to get a list of installed plugins...
Jan 07 08:42:29 linux node[10174]: [2022-01-07 08:42:29.259] [INFO] plugins - npm --version: 6.14.15
Jan 07 08:42:32 linux node[10174]: [2022-01-07 08:42:32.139] [INFO] plugins - Loading plugin ep_etherpad-lite...
Jan 07 08:42:32 linux node[10174]: [2022-01-07 08:42:32.141] [INFO] plugins - Loaded 1 plugins
Jan 07 08:42:32 linux node[10174]: [2022-01-07 08:42:32.793] [INFO] APIHandler - Api key file read from: "/opt/etherpad/etherpad-lite/APIKEY.>
Jan 07 08:42:32 linux node[10174]: [2022-01-07 08:42:32.854] [INFO] server - Installed plugins:
Jan 07 08:42:32 linux node[10174]: [2022-01-07 08:42:32.887] [INFO] console - Report bugs at https://github.com/ether/etherpad-lite/issues
Jan 07 08:42:32 linux node[10174]: [2022-01-07 08:42:32.888] [INFO] console - Your Etherpad version is 1.8.16 (142a47c)
Zu diesem Zeitpunkt ist Etherpad gestartet und hört auf Port 9001. Du kannst dies mit dem folgenden Befehl überprüfen:
ss -antpl | grep 9001
Du erhältst die folgende Ausgabe:
LISTEN 0 128 0.0.0.0:9001 0.0.0.0:* users:(("node",pid=10174,fd=27))
Sobald du fertig bist, kannst du mit dem nächsten Schritt fortfahren.
Nginx als Reverse Proxy für Etherpad konfigurieren
Als Nächstes musst du Nginx als Reverse-Proxy für Etherpad konfigurieren. Installiere zunächst das Nginx-Paket mit dem folgenden Befehl:
dnf install nginx -y
Sobald Nginx installiert ist, starte und aktiviere den Nginx-Dienst mit dem folgenden Befehl:
systemctl start nginx systemctl enable nginx
Als Nächstes erstellst du eine Konfigurationsdatei für den virtuellen Nginx-Host mit folgendem Befehl:
nano /etc/nginx/conf.d/etherpad.conf
Füge die folgenden Zeilen ein:
server {
listen 80;
server_name etherpad.exampledomain.com;
access_log /var/log/nginx/etherpad.access.log;
error_log /var/log/nginx/etherpad.error.log;
location / {
rewrite ^/$ / break;
rewrite ^/locales/(.*) /locales/$1 break;
rewrite ^/locales.json /locales.json break;
rewrite ^/admin(.*) /admin/$1 break;
rewrite ^/p/(.*) /p/$1 break;
rewrite ^/static/(.*) /static/$1 break;
rewrite ^/pluginfw/(.*) /pluginfw/$1 break;
rewrite ^/javascripts/(.*) /javascripts/$1 break;
rewrite ^/socket.io/(.*) /socket.io/$1 break;
rewrite ^/ep/(.*) /ep/$1 break;
rewrite ^/minified/(.*) /minified/$1 break;
rewrite ^/api/(.*) /api/$1 break;
rewrite ^/ro/(.*) /ro/$1 break;
rewrite ^/error/(.*) /error/$1 break;
rewrite ^/jserror(.*) /jserror$1 break;
rewrite ^/redirect(.*) /redirect$1 break;
rewrite /favicon.ico /favicon.ico break;
rewrite /robots.txt /robots.txt break;
rewrite /(.*) /p/$1;
proxy_pass http://127.0.0.1:9001;
proxy_buffering off;
proxy_set_header Host $host;
proxy_pass_header Server;
# proxy headers
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_http_version 1.1;
# websocket proxying
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
}
}
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
Speichere und schließe die Datei und überprüfe den Nginx auf Syntaxfehler:
nginx -t
Du erhältst die folgende Ausgabe:
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok nginx: configuration file /etc/nginx/nginx.conf test is successful
Starte Nginx schließlich neu, um die Konfigurationsänderungen zu übernehmen:
systemctl restart nginx
Jetzt kannst du den Nginx-Status mit dem folgenden Befehl überprüfen:
systemctl status nginx
Du erhältst die folgende Ausgabe:
? nginx.service - The nginx HTTP and reverse proxy server
Loaded: loaded (/usr/lib/systemd/system/nginx.service; disabled; vendor preset: disabled)
Drop-In: /usr/lib/systemd/system/nginx.service.d
??php-fpm.conf
Active: active (running) since Fri 2022-01-07 08:58:36 UTC; 6s ago
Process: 10238 ExecStart=/usr/sbin/nginx (code=exited, status=0/SUCCESS)
Process: 10236 ExecStartPre=/usr/sbin/nginx -t (code=exited, status=0/SUCCESS)
Process: 10234 ExecStartPre=/usr/bin/rm -f /run/nginx.pid (code=exited, status=0/SUCCESS)
Main PID: 10240 (nginx)
Tasks: 2 (limit: 11411)
Memory: 3.7M
CGroup: /system.slice/nginx.service
??10240 nginx: master process /usr/sbin/nginx
??10241 nginx: worker process
Jan 07 08:58:36 linux systemd[1]: nginx.service: Succeeded.
Jan 07 08:58:36 linux systemd[1]: Stopped The nginx HTTP and reverse proxy server.
Jan 07 08:58:36 linux systemd[1]: Starting The nginx HTTP and reverse proxy server...
Jan 07 08:58:36 linux nginx[10236]: nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
Jan 07 08:58:36 linux nginx[10236]: nginx: configuration file /etc/nginx/nginx.conf test is successful
Jan 07 08:58:36 linux systemd[1]: nginx.service: Failed to parse PID from file /run/nginx.pid: Invalid argument
Jan 07 08:58:36 linux systemd[1]: Started The nginx HTTP and reverse proxy server.
Firewall für Etherpad konfigurieren
Als Nächstes musst du die Ports 80 und 443 über die Firewall Firewalld zulassen. Du kannst sie mit dem folgenden Befehl zulassen:
firewall-cmd --zone=public --permanent --add-service=http firewall-cmd --zone=public --permanent --add-service=https
Lade als Nächstes die Firewalld neu, um die Änderungen zu übernehmen:
firewall-cmd --reload
Zugriff auf die Etherpad-Weboberfläche
Öffne nun deinen Webbrowser und rufe die Etherpad-Weboberfläche über die URL http://etherpad.exampledomain.com auf. Du solltest den folgenden Bildschirm sehen:
Gib deinen Pad-Namen ein und klicke auf die Schaltfläche OK. Du solltest die Etherpad-Seite auf dem folgenden Bildschirm sehen:
Etherpad mit Let’s Encrypt SSL sichern
Um das Etherpad mit Let’s Encrypt SSL zu sichern, musst du den Certbot-Client auf deinem System installieren. Du kannst ihn mit dem folgenden Befehl installieren:
dnf install epel-release -y dnf install certbot -y
Als Nächstes führst du den folgenden Befehl aus, um Let’s Encrypt SSL für deine Etherpad-Website herunterzuladen und zu installieren:
certbot --nginx -d etherpad.exampledomain.com
Du wirst aufgefordert, deine gültige E-Mail-Adresse anzugeben und die Nutzungsbedingungen zu akzeptieren (siehe unten):
Saving debug log to /var/log/letsencrypt/letsencrypt.log Plugins selected: Authenticator nginx, Installer nginx Enter email address (used for urgent renewal and security notices) (Enter 'c' to cancel): hitjethva@gmail.com - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Please read the Terms of Service at https://letsencrypt.org/documents/LE-SA-v1.2-November-15-2017.pdf. You must agree in order to register with the ACME server at https://acme-v02.api.letsencrypt.org/directory - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - (A)gree/(C)ancel: A - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Would you be willing to share your email address with the Electronic Frontier Foundation, a founding partner of the Let's Encrypt project and the non-profit organization that develops Certbot? We'd like to send you email about our work encrypting the web, EFF news, campaigns, and ways to support digital freedom. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - (Y)es/(N)o: Y Obtaining a new certificate Performing the following challenges: http-01 challenge for etherpad.exampledomain.com Waiting for verification... Cleaning up challenges Deploying Certificate to VirtualHost /etc/nginx/conf.d/etherpad.conf
Als Nächstes wählst du aus, ob der HTTP-Verkehr auf HTTPS umgeleitet werden soll oder nicht:
Please choose whether or not to redirect HTTP traffic to HTTPS, removing HTTP access. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1: No redirect - Make no further changes to the webserver configuration. 2: Redirect - Make all requests redirect to secure HTTPS access. Choose this for new sites, or if you're confident your site works on HTTPS. You can undo this change by editing your web server's configuration. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Select the appropriate number [1-2] then [enter] (press 'c' to cancel): 2
Gib 2 ein und drücke die Eingabetaste, um den Vorgang zu starten. Sobald das Zertifikat installiert ist, solltest du die folgende Ausgabe sehen:
Redirecting all traffic on port 80 to ssl in /etc/nginx/conf.d/etherpad.conf - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Congratulations! You have successfully enabled https://etherpad.exampledomain.com You should test your configuration at: https://www.ssllabs.com/ssltest/analyze.html?d=etherpad.exampledomain.com - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - IMPORTANT NOTES: - Congratulations! Your certificate and chain have been saved at: /etc/letsencrypt/live/etherpad.exampledomain.com/fullchain.pem Your key file has been saved at: /etc/letsencrypt/live/etherpad.exampledomain.com/privkey.pem Your cert will expire on 2022-04-10. To obtain a new or tweaked version of this certificate in the future, simply run certbot again with the "certonly" option. To non-interactively renew *all* of your certificates, run "certbot renew" - Your account credentials have been saved in your Certbot configuration directory at /etc/letsencrypt. You should make a secure backup of this folder now. This configuration directory will also contain certificates and private keys obtained by Certbot so making regular backups of this folder is ideal. - If you like Certbot, please consider supporting our work by: Donating to ISRG / Let's Encrypt: https://letsencrypt.org/donate Donating to EFF: https://eff.org/donate-le - We were unable to subscribe you the EFF mailing list because your e-mail address appears to be invalid. You can try again later by visiting https://act.eff.org.
Schlussfolgerung
Herzlichen Glückwunsch! Du hast Etherpad mit Nginx und Let’s Encrypt SSL erfolgreich auf Alma Linux 8 installiert. Du kannst jetzt zusätzliche Plugins installieren, um die Funktionalität von Etherpad zu erweitern. Wenn du noch Fragen hast, kannst du dich gerne an mich wenden.