Quelltext der Seite Etherpad

Einer unserer [[Dienste]] ist Etherpad, ein kollaborativer Editor im Webbrowser.

Er ist ohne Anmeldung zu erreichen unter https://ep.mafiasi.de

Inzwischen wurde die Instanz auf [https://github.com/ether/etherpad-lite Etherpad-Lite] migriert.
Die Wiki-Seite zur alten Instanz lässt sich unter [[Etherpad (alt)]] finden.

Eine Alternative ist Gobby, was richtige GTK+ Widget anbietet und sich somit intuitiver und sinnvoller bedienen laesst. Leider bieten wir noch keinen Gobby-Service an. Wenn du Lust hast, das zu bauen, melde dich an server-ag@.

== Gespeicherte Daten ==

=== Etherpad ===

Alle über Etherpad eingegebenen Daten werden derzeit unbefristet gespeichert. Dies betrifft:

* Das Dokument selber
* Die Historie des Dokuments
* Das Chatprotokoll

=== Apache ===

Da die Verbindungen zum Etherpad über den Apache geschleift werden, loggt dieser zudem die Verbindungen mit den folgenden Informationen:

* Hostname/IP-Adresse des Clients
* Zeitpunkt des Zugriffs
* Informationen des Browsers des Clients
* Den Dokumentennamen eines Etherpads (GET-Parameter)

Diese Informationen werden allerdings nach 3 Wochen gelöscht.

== ToDos ==
Ein tolles Feature waere, wenn sich jmd ein Etherpad reservieren kann. Der Usecase ist, dass die Sachen in dem EP nicht weltoeffentlich zu sein haben, sondern nur fuer a) eine Person, b) eine Liste von Mafiasi oder c) nur Mafiasi.
Dazu muesste das Etherpad irgendwie an den gerade angemeldeten Benutzer rankommen. Das ginge vll. mit einem OpenID provider, den wir noch aufzusetzen haetten.
Und dann muesste natuerlich die noetige Logik in Etherpad implementiert werden, dass ein Pad eben mit einer Art ACL versehen werden kann.

Es waere auch toll, wenn der Benutzer sich eine Gobby Instanz klicken koennte. Potentielle Probleme sind die Firewall (man koennte das auf der Hetzner Maschine laufen lassen) und verwaiste Sessions (koennte evtl. durch eine Art Counter implementiert werden, i.e. keine Aenderungen mehr seit >7 Tagen: Session beenden. Idealerweise wieder herstellbar machen).

== Interna ==

[https://github.com/ether/etherpad-lite Etherpad-lite] ist eine JavaScript-Neuimplementation (über [http://nodejs.org/ nodejs]) des in Java geschriebenen Etherpads und ist daher deutlich weniger Ressourcenhungrig.

Die Instanz läuft auf dem Fachschaftsserver im RZ des Informatikums.

Wir benutzen direkt die Version aus dem git, welche in <tt>/var/lib/etherpad-lite/</tt> liegt. Sie wird ab und zu von 6keitzel auf den neusten Stand gebracht. Die Abhängigkeit [http://nodejs.org/ nodejs] wurde manuell kompiliert und paketiert und liegt derzeit in Version 0.6.4 vor. Die Einrichtung folgte generell der offiziellen [https://github.com/Pita/etherpad-lite Installationsanleitung].

Für das Setup werden Einstellungen für diverse Komponenten benötigt. Dazu gehört Etherpad-lite selber, MySQL, Apache, ein Init-Skript und eine Logrotate-Konfiguration.

=== Etherpad-lite ===

Etherpad-lite wird über <tt>/var/lib/etherpad-lite/etherpad-lite/settings.json</tt> konfiguriert. In der derzeitigen Konfiguration lauscht der Daemon lokal auf Port <tt>9001</tt> und benutzt eine MySQL-Datenbank für die Persistierung. Für Etherpad-lite wurde ein Systembenutzer angelegt, welcher sich nicht eigentändig einloggen darf.

=== MySQL ===

Die Datenbank heißt <tt>etherpad_lite</tt>. Die Benutzerdaten stehen in <tt>/var/lib/etherpad-lite/etherpad-lite/settings.json</tt>.

=== Apache ===

Der lokal-lauschende Daemon wird über Apache als Reverse Proxy von außen erreichbar. Die relevanten Konfigurationsdateien sind:

* <tt>/etc/apache2/sites-templates/ep.mafiasi.de</tt>
* <tt>/etc/apache2/sites-available/ep.mafiasi.de</tt>
* <tt>/etc/apache2/sites-available/ep.mafiasi.de-ssl</tt>

=== Init-Skript ===

Der Daemon wird über das Init-Skript <tt>/etc/init.d/etherpad-lite</tt> verwaltet. Darüber wird Etherpad-lite auch beim Systemstart mitgestartet.

=== Logrotate ===

Etherpad-lite loggt nach <tt>/var/log/etherpad-lite/etherpad-lite.log</tt>. Damit dieser Log nicht vollläuft wacht Logrotate über diesen Log mit der Konfiguration aus <tt>/etc/logrotate.d/etherpad-lite</tt>.