Etherpad Installieren

2025-09-01T09:46:16Z

Wme00: /* v2: Konfiguration mit Proxy und systemd */ : Pfad auf die user systemd Konfiguration war nicht eindeutig.

= Etherpad Lite installieren =

Etherpad ist eine JavaScript-Anwendung mit der mehrere Bearbeiter gleichzeitig einen Text im Browser editieren können.

Mit Hilfe von Etherpad können zum Beispiel die Teilnehmer einer Telefonkonferenz gemeinsam an einem Text-Dokument arbeiten.

== Vorbereitung ==

Als Paket-Admin ''xyz00'' werden mit HSAdmin ein User angelegt und eine Domain aufgeschaltet. Eine produktive Installation von Etherpad braucht zusätzlich einen MySQL-User und eine MySQL-Datenbank.

Mit ''hsscript'' können diese Ressourcen wie folgt angelegt werden:

Als Paketadmin ''xyz00'' aufrufen: <code>hsscript -i</code>

In der HSAdmin-Shell gibt man dann ein:

<syntaxhighlight lang=shell>
xyz00@hsadmin> user.add({set:{name:'xyz00-pad', password:'mein-Geheimwort', shell:'/bin/bash'}})
xyz00@hsadmin> domain.add({set:{name:'pad.example.com', user:'xyz00-pad'}})
xyz00@hsadmin> mysqluser.add({set:{name:'xyz00_padusr', password:'anderes-Geheimwort'}})
xyz00@hsadmin> mysqldb.add({set:{name:'xyz00_paddb', owner:'xyz00_padusr'}})
xyz00@hsadmin> bye
</syntaxhighlight>

== Installation ==

Etherpad v2.2.7 benötigt ''nodejs'' in einer Version > 18.18. Die Installation erfolgt gemäß der Wiki-Anleitung: [[NodeJS]]

Zusätzlich muss der Paketmanager pnpm für Version 2 vorgehalten werden

npm install pnpm@latest-10

Als Paketadmin ''xyz00'' nimmt man mit <code>sudo -u xyz00-pad -i</code> die Rechte des Domain-Administrators ''xyz00-pad'' für die neue Domain ''pad.example.com'' an.

Die Etherpad-Software kann aus dem Git-Repository bei Github ausgecheckt werden:

<syntaxhighlight lang=shell>
cd
git clone https://github.com/ether/etherpad-lite.git
cd etherpad-lite/
git tag -l
git checkout tags/2.2.7
./bin/run.sh
</syntaxhighlight>

Mit "git checkout tags/2.2.7" wird Release 2.2.7 ausgecheckt, die heute (06.03.2025) aktuelle Version.

Bei der Initialisierung der Anwendung gibt es einige Warnungen, die man ignorieren kann. Wenn die Initialisierung durchgelaufen ist, kann man
unter der URL http://xyz00.hostsharing.net:9001/ schon die die Etherpad-Anwendung ohne Datenbank und ohne die gewünschte Domain sehen.

Wir brechen das ''run.sh''-Skript mit Ctrl-c ab.

== v2: Konfiguration mit Proxy und systemd ==

# ~/.config/systemd/user/etherpad-lite.service
[Unit]
Description=Etherpad-Lite Service
[Service]
WorkingDirectory=%h/etherpad-lite
Environment="NODE_ENV=production"
Environment="BIND=127.0.0.1"
Environment="PATH=/home/pacs/xyz00/users/tools_pad/.nvm/versions/node/v20.18.3/bin:/usr/local/bin:/usr/bin:/bin"
ExecStart=%h/.nvm/versions/node/v20.18.3/bin/pnpm run prod
[Install]
WantedBy=default.target

# ~/doms/pad.example.com/.htaccess
DirectoryIndex disabled
RewriteBase /
RewriteCond %{HTTP:Connection} Upgrade [NC]
RewriteCond %{HTTP:Upgrade} websocket [NC]
RewriteRule .* ws://localhost:9001%{REQUEST_URI} [proxy]
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-l
RewriteRule .* http://localhost:9001%{REQUEST_URI} [proxy]

Wichtig ist, dass auf 127.0.0.1 ge-binded wird, und nicht die von Welt erreichbare Adresse 0.0.0.0. Man beachte das im Systemd Service File die node version hardcoded wird und beim Update zwei mal entsprechend angepasst werden muss. Genauso der User und der Paketusername, der leider nicht direkt ersetzt werden kann.

Dass auch nach Neustart der Etherpad Server erreichbar ist:

systemctl --user enable etherpad-lite

== v1: Konfiguration für Apache und Passenger ==

Vor der Nutzung von [[Phusion Passenger]] bitte unbedingt die dortigen Hinweise zur Nutzung beachten.

Die statischen Dateien der Anwendung werden mit den folgenden Befehlen richtig verlinkt
(immer noch als User ''xyz00-pad''):

<syntaxhighlight lang=shell>
cd
cd ~/doms/pad.example.com
rm -rf subs/www
rm -rf subs-ssl/www
rm -rf htdocs-ssl
ln -s ~/etherpad-lite/src/static htdocs-ssl
</syntaxhighlight>

Für die Anwendung legen wir im Verzeichnis ''~/doms/pad.example.com/app-ssl/'' eine Datei app.js mit dem folgenden Inhalt an:

<syntaxhighlight lang=javascript>
require('/home/pacs/xyz00/users/pad/etherpad-lite/node_modules/ep_etherpad-lite/node/server.js');
process.chdir('/home/pacs/xyz00/users/pad/etherpad-lite');
</syntaxhighlight>

= Datenbank anpassen =

Zum Schluß wird in der Datei ''~/etherpad-lite/settings.js'' noch die MySQL-Datenbank konfiguriert. Dazu muss der Teil mit ''dbType: mysql'' aktiv (nicht auskommentiert) sein. Etwa wie folgt:

<syntaxhighlight lang=javascript>
"dbType" : "mysql",
"dbSettings" : {
"user" : "xyz00_padusr",
"host" : "localhost",
"password": "anderes-Geheimwort",
"database": "xyz00_paddb",
"charset" : "utf8mb4",
"insecureAuth": "true"
},
</syntaxhighlight>

Die Einstellungen für den ''dbType: dirty'' werden dafür entfernt.

Weiter unten in der Datei kann dann noch ein Admin-User aktiviert werden.

Etherpad sollte nun unter der URL: ''http://pad.example.com/'' erreichbar sein.

= Update =

Etherpad ist sehr pflegeleicht was das Update angeht. Es muss nur die neue Version in Git ausgecheckt werden und ./bin/run.sh erneut (einmalig) ausgeführt werden, damit die dependencies wieder neu gebaut werden. Auch von v1 -> v2 ist sonst nichts weiter zu tun.

= Links =

*[http://etherpad.org/ Etherpad Homepage (Englisch)]
*[https://github.com/ether/etherpad-lite/ Github Repository (Englisch)]
*[https://github.com/ether/etherpad-lite/wiki/Running-Etherpad-on-Phusion-Passenger Running Etherpad on Phusion Passenger (Englisch)]

----
[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Software]]
[[Kategorie:Passenger]]
[[Kategorie:NodeJS]]

Hostsharing Wiki - Benutzerbeiträge [de]

Etherpad Installieren