Collabora Online (richdocuments) #

Diese App verbindet owncloud.online mit einem Collabora-Online-Server, damit Text-, Tabellen- und Präsentationsdokumente im Browser bearbeitet werden können. owncloud.online liefert dabei die Datei über das WOPI-Protokoll aus (WOPI-Host), die eigentliche Bearbeitung übernimmt der Collabora-Server (WOPI-Client). Die App bringt selbst keine Office-Engine mit.

Was die App tut #

• Öffnet Dokumente in einem eingebetteten Collabora-Fenster (iframe) aus der Dateiliste, aus öffentlichen Links und über Federation.
• Legt neue Dokumente an, wahlweise im ODF- oder im OOXML-Format.
• Ergänzt einen Navigationseintrag „Büro", der sich abschalten lässt.
• Stellt die WOPI-Schnittstelle bereit, über die der Collabora-Server die Datei liest und zurückschreibt (index.php/apps/richdocuments/wopi/files/…).
• Bietet Secure View (Wasserzeichen, Sperren von Drucken und Export) sowie die Zotero-Anbindung für Literaturverweise.
• Räumt abgelaufene WOPI-Zugriffstoken über einen Hintergrundjob aus der Tabelle richdocuments_wopi auf. Ein Token ist 36000 Sekunden (10 Stunden) gültig.

Voraussetzungen #

• owncloud.online 11.x und PHP 8.4 (siehe appinfo/info.xml).
• Ein erreichbarer Collabora-Online-Server, der unter <adresse>/hosting/discovery eine gültige WOPI-Discovery-XML ausliefert.
• Ein eingerichteter Cron-Lauf, damit der Hintergrundjob CleanupExpiredWopiTokens abgelaufene Token löscht.
• Für Secure View eine gültige Lizenz; ohne Lizenz ist das Kästchen im Administrationsbereich ausgegraut.
• Falls Verschlüsselung aktiv ist: ausschließlich Masterkey-Verschlüsselung. Bei anderen Verfahren weist der Administrationsbereich auf die eingeschränkte Funktion hin, weil die App privilegierten Zugriff auf die Dateien benötigt.

Beide Seiten müssen sich gegenseitig erreichen #

Eine Anbindung funktioniert nur, wenn alle drei Verbindungen offen sind. Die Beispiele verwenden https://cloud.example.com für owncloud.online und https://collabora.example.com:9980 für den Collabora-Server; setzen Sie Ihre eigenen Adressen ein.

Beide Seiten sollten dasselbe Schema verwenden. Speichern Sie eine Adresse mit http, während owncloud.online über https läuft, meldet die App beim Speichern, dass Collabora Online dasselbe Protokoll wie die Serverinstallation verwenden sollte. Für Testaufbauten ohne TLS betreiben Sie deshalb beide Seiten über http.

Installation #

Der einfachere Weg führt über den Markt: dort die App suchen, installieren und aktivieren. Von Hand geht es so:

cd /var/www/owncloud.online/apps
git clone https://github.com/BWTECH-github/richdocuments.git
cd richdocuments
composer install --no-dev
chown -R www-data:www-data .
sudo -u www-data php8.4 ../../occ app:enable richdocuments

Einstellungen #

Die Oberfläche findet sich im Administrationsbereich im Abschnitt additional unter den Überschriften „Collabora Online", „Secure View für Collabora Online" und „Zotero für Collabora Online". Die dort gezeigten Werte lassen sich auch auf der Kommandozeile setzen. open_in_new_tab und start_grace_period haben kein Bedienelement in der Oberfläche und lassen sich ausschließlich auf der Kommandozeile setzen.

Der wichtigste Wert ist die Serveradresse. Geben Sie sie immer vollständig an, also mit Schema und Port; ohne http- oder https-Schema lehnt die App die Eingabe ab.

Zusätzlich wertet die App zwei Werte außerhalb der eigenen App-Einstellungen aus:

• Systemwert collabora_group: Ist er gesetzt, dürfen nur Mitglieder dieser Gruppe die App verwenden. Ist die Gruppe unbekannt, wird niemand zugelassen und ein Fehler protokolliert.
• Benutzerwert zoteroAPIPrivateKey: der persönliche Zotero-Schlüssel, den Benutzer selbst in ihren persönlichen Einstellungen unter „Persönlicher API-Schlüssel für Zotero:" hinterlegen.

Kommandozeile #

Die App bringt keine eigenen occ-Befehle mit; die Werte werden mit den Standardbefehlen von owncloud.online gesetzt und gelesen:

sudo -u www-data php8.4 occ config:app:set richdocuments wopi_url \
    --value https://collabora.example.com:9980
sudo -u www-data php8.4 occ config:app:get richdocuments wopi_url

Secure View mit Wasserzeichen einschalten:

sudo -u www-data php8.4 occ config:app:set richdocuments \
    secure_view_option --value true
sudo -u www-data php8.4 occ config:app:set richdocuments \
    secure_view_open_action_default --value true
sudo -u www-data php8.4 occ config:app:set richdocuments \
    watermark_text --value "Nur für {viewer-email}"

Anbindung an die Web-Oberfläche #

Für die Web-Oberfläche wird die App zusätzlich in deren config.json eingetragen. Die App liefert die dafür nötige Datei unter einer eigenen Route aus:

"external_apps": [
    {
        "id": "richdocuments",
        "path": "https://cloud.example.com/index.php/apps/richdocuments/js/richdocuments.js"
    }
]

Die ausgelieferte Datei liegt im Repository unter js/web/richdocuments.js und ist bereits gebaut. Wer sie selbst erzeugen möchte, verwendet die Skripte aus package.json:

pnpm install
pnpm build

Fehlersuche #

Die Meldungen der App stehen im Protokoll von owncloud.online unter der Kennung richdocuments. Einzige Ausnahme ist die Meldung über eine unbekannte collabora_group, die unter der Kennung collabora protokolliert wird.

Herkunft #

Diese App geht auf richdocuments von Collabora Productivity zurück, aufbauend auf Arbeiten von Frank Karlitschek und Victor Dubiniuk und gepflegt von der ownCloud GmbH. Lizenz: AGPL-3.0.

Angepasst von der BW-Tech GmbH für owncloud.online und PHP 8.4.

• Quelltext und Fehlermeldungen: https://github.com/BWTECH-github/richdocuments
• Dokumentation: https://docs.owncloud.online
• Produktseite: https://owncloud.online