Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core Module und Plugins > Integration | ONLYOFFICE

Integration | ONLYOFFICE administrieren

Hinweis: Diese Dokumentation bezieht sich auf die aktuellste Version des Plugins. Aktualisieren Sie das hier beschriebene Plugin, um die Dokumentation verwenden zu können.

Voraussetzungen

Für die Nutzung von ONLYOFFICE in agorum core ist der Document Server ONLYOFFICE Docs notwendig.

Hinweis: Der Community Server ist nicht der Document Server. Um ONLYOFFICE Docs per API von außen ansprechen zu können, müssen Sie zwingend den Document Server ONLYOFFICE Docs installieren.

agorum core unterstützt alle verfügbaren Server-Editionen (Stand 2020):

Community Edition
Enterprise Edition
Integration Edition
Developer Edition

Wenden Sie sich an den offiziellen Hersteller für Rückfragen bezüglich der für Ihren Einsatzzweck benötigten Lizenz.

Netzwerk

Damit Dokumente geöffnet und gespeichert werden können, müssen sich die beteiligten Server gegenseitig erreichen:

Die Browser der Benutzer erreichen den ONLYOFFICE-Server. Rufen die Benutzer agorum core über HTTPS auf, muss auch ONLYOFFICE über HTTPS erreichbar sein, sonst blockiert der Browser den Editor.
Der ONLYOFFICE-Server erreicht agorum core: ONLYOFFICE lädt die Dokumente von agorum core und meldet das Speichern dorthin zurück. Liegt agorum core in einem privaten Netz, muss auf dem ONLYOFFICE-Server ALLOW_PRIVATE_IP_ADDRESS=true gesetzt sein.
agorum core erreicht den ONLYOFFICE-Server: agorum core holt dort das gespeicherte Dokument ab.

ONLYOFFICE kann auf Ihren eigenen Servern und in der Cloud betrieben werden. Im Falle der Cloud muss eine Besonderheit bezüglich der Kommunikation zwischen agorum core und ONLYOFFICE beachtet werden.

Ob die Verbindungen funktionieren, prüfen Sie direkt in der Einrichtung mit Verbindung prüfen.

Integration | ONLYOFFICE einrichten

Sobald Sie das Plugin installiert haben, müssen Sie die Verbindung zu ONLYOFFICE herstellen. Die Verbindung richten nur Administratoren ein.

Voraussetzung: Sie sind als Administrator angemeldet (im Benutzermenü Als Administrator anmelden).

Klicken Sie auf einer beliebigen Seite innerhalb von agorum core oben rechts auf .
Wählen Sie Administration > Konfiguration > ONLYOFFICE Verbindung einrichten.

Ergebnis: Die Maske ONLYOFFICE Verbindung einrichten öffnet sich.
Befüllen Sie die Eingabefelder.
Klicken Sie auf Verbindung prüfen und kontrollieren Sie das Ergebnis.
Klicken Sie auf Speichern.

Ergebnis: Die Maske schließt sich. Bei korrekten Einstellungen können die Benutzer ab sofort Dokumente mit ONLYOFFICE betrachten und bearbeiten.

Verbindung zwischen ONLYOFFICE und agorum core einrichten

Abbrechen oder die Escape-Taste schließen die Maske, ohne zu speichern.

Felder

Alle Felder sind Pflichtfelder. Leerzeichen am Anfang und Ende sowie / am Ende der Adressen entfernt agorum core beim Prüfen und Speichern selbst.

Eingabefeld	Beschreibung	Beispiel
ONLYOFFICE Documentserver URL	Definiert die URL zum Document Server ONLYOFFICE Docs. Die URL muss vom Browser des Benutzers aus erreichbar sein.	https://agorum-office-01.example.com
agorum core URL	Definiert die URL zum agorum core Server. Die URL muss von ONLYOFFICE Docs aus erreichbar sein.	https://agorumdms.ihrefirma.de Wenn der ONLYOFFICE-Server im selben Netzwerk installiert ist wie der agorum core Server, können Sie auch die interne IP verwenden: http://192.168.0.100
ONLYOFFICE Dokumentenserver "Secret" oder "Token" (JWT)	Bei der Einrichtung von ONLYOFFICE muss ein secret token konfiguriert werden (https://api.onlyoffice.com/editors/signature/). Tragen Sie dieses Secret in das Eingabefeld ein. Wird ONLYOFFICE in der agorum cloud betrieben, erhalten Sie stattdessen ein Token (JWT), das Sie hier eintragen. Das Secret wird bei ONLYOFFICE in der Datei /etc/onlyoffice/documentserver/local.json eingestellt. Die Token müssen aktiviert sein. Ein geheimes Secret muss eingestellt sein. Mit dem Augen-Symbol rechts neben dem Feld blenden Sie die Eingabe ein und aus. agorum core speichert das Secret verschlüsselt. Hinweis: Beachten Sie die Hinweise auf der offiziellen Website des Herstellers. Die Informationen rechts im Feld Beispiel sind ein aktueller Auszug der Konfiguration, Stand 2020. Wenn Sie Änderungen an der Datei local.json vorgenommen haben, müssen Sie den Service mit folgendem Befehl neu starten: supervisorctl restart all	// ... "token": { "enable": { "request": { "inbox": true, "outbox": true }, "browser": true }, "inbox": { "header": "Authorization" }, "outbox": { "header": "Authorization" } }, "secret": { "inbox": { "string": "meingeheimessecret" }, "outbox": { "string": "meingeheimessecret" }, "session": { "string": "meingeheimessecret" } } // ...

Eingabefeld

Beschreibung

Beispiel

ONLYOFFICE Documentserver URL

Definiert die URL zum Document Server ONLYOFFICE Docs.

Die URL muss vom Browser des Benutzers aus erreichbar sein.

https://agorum-office-01.example.com

agorum core URL

Definiert die URL zum agorum core Server.

Die URL muss von ONLYOFFICE Docs aus erreichbar sein.

https://agorumdms.ihrefirma.de

Wenn der ONLYOFFICE-Server im selben Netzwerk installiert ist wie der agorum core Server, können Sie auch die interne IP verwenden:

http://192.168.0.100

ONLYOFFICE Dokumentenserver "Secret" oder "Token" (JWT)

Bei der Einrichtung von ONLYOFFICE muss ein secret token konfiguriert werden (https://api.onlyoffice.com/editors/signature/). Tragen Sie dieses Secret in das Eingabefeld ein. Wird ONLYOFFICE in der agorum cloud betrieben, erhalten Sie stattdessen ein Token (JWT), das Sie hier eintragen.

Das Secret wird bei ONLYOFFICE in der Datei /etc/onlyoffice/documentserver/local.json eingestellt.
Die Token müssen aktiviert sein.
Ein geheimes Secret muss eingestellt sein.

Mit dem Augen-Symbol rechts neben dem Feld blenden Sie die Eingabe ein und aus. agorum core speichert das Secret verschlüsselt.

Hinweis: Beachten Sie die Hinweise auf der offiziellen Website des Herstellers. Die Informationen rechts im Feld Beispiel sind ein aktueller Auszug der Konfiguration, Stand 2020.

Wenn Sie Änderungen an der Datei local.json vorgenommen haben, müssen Sie den Service mit folgendem Befehl neu starten:

supervisorctl restart all

// ...
"token": {
  "enable": {
    "request": {
      "inbox": true,
      "outbox": true
    },
    "browser": true
  },
  "inbox": {
    "header": "Authorization"
  },
  "outbox": {
    "header": "Authorization"
  }
},
"secret": {
  "inbox": {
    "string": "meingeheimessecret"
  },
  "outbox": {
    "string": "meingeheimessecret"
  },
  "session": {
    "string": "meingeheimessecret"
  }
}
// ...

Secret ab ONLYOFFICE 7.2.0

Ab ONLYOFFICE 7.2.0 wird das Secret bereits erzeugt. Sie können es mit folgendem Befehl anzeigen:

documentserver-jwt-status.sh

Auszug aus der Konfiguration:

// ...
"secret": {
  "inbox": {
    "string": "xx"
  },
  "outbox": {
    "string": "xx"
  },
  "session": {
    "string": "xx"
  }
},
// ...

Verbindung prüfen

Mit Verbindung prüfen prüfen Sie die Werte, wie sie gerade in der Maske stehen, ohne sie zu speichern. Die Prüfung läuft in drei Schritten; jeder Schritt läuft nur, wenn der vorige geklappt hat, sonst steht dort nicht geprüft, weil der Schritt davor nicht geklappt hat.

Schritt	Was geprüft wird	Häufige Meldungen und Lösung
agorum core → ONLYOFFICE	agorum core erreicht den ONLYOFFICE-Server unter der ONLYOFFICE Documentserver URL.	nicht erreichbar: Prüfen Sie die Adresse und ob der ONLYOFFICE-Server läuft. Die Adresse muss mit http:// oder https:// beginnen.: Ergänzen Sie die Adresse.
Secret	Das eingetragene Secret passt zum Secret des ONLYOFFICE-Servers. Bei Erfolg nennt die Meldung die Version von ONLYOFFICE.	passt nicht zum Secret des ONLYOFFICE-Servers (JWT_SECRET): Tragen Sie das Secret des ONLYOFFICE-Servers ein. kein Secret eingetragen: Füllen Sie das Feld.
ONLYOFFICE → agorum core (Rückweg)	ONLYOFFICE ruft über die agorum core URL eine Testdatei ab – auf demselben Weg, auf dem die Editoren die Dokumente laden und das Speichern zurückmelden.	ONLYOFFICE erreicht agorum core unter … nicht: Prüfen Sie vom ONLYOFFICE-Server aus Adresse, Namensauflösung und Firewall. Liegt agorum core in einem privaten Netz, setzen Sie auf dem ONLYOFFICE-Server ALLOW_PRIVATE_IP_ADDRESS=true. Die Testdatei … fehlt: Installieren Sie das Plugin erneut. Die Adresse muss mit http:// oder https:// beginnen.: Ergänzen Sie die agorum core URL.

Das Ergebnis erscheint unter den Feldern. Ändern Sie danach einen Wert, bleibt das Ergebnis stehen und wird als Ergebnis der letzten Prüfung – Werte seither geändert gekennzeichnet. Prüfen Sie dann erneut.

Ergebnis der Prüfung: ONLYOFFICE-Server nicht erreichbar

So wird die Verbindung gespeichert

agorum core speichert das Secret verschlüsselt und an das System gebunden. Das hat folgende Folgen:

Kopieren Sie das System, etwa für ein Testsystem, lässt sich das Secret auf der Kopie nicht entschlüsseln. ONLYOFFICE gilt dort als nicht eingerichtet. Tragen Sie das Secret auf der Kopie neu ein und speichern Sie.
Ein mit einer älteren Plugin-Version im Klartext gespeichertes Secret gilt weiter und wird beim nächsten Speichern verschlüsselt. Danach kann eine ältere Plugin-Version das Secret nicht mehr lesen.
Ältere Versionen der Konfiguration enthalten ein früher gespeichertes Secret weiter im Klartext. Wollen Sie das ausschließen, wechseln Sie das Secret (JWT) im ONLYOFFICE-Server und tragen Sie das neue Secret hier ein.

Ist die gespeicherte Konfiguration nicht verwendbar, öffnet sich die Maske trotzdem und nennt den Grund:

Die gespeicherte Konfiguration ist nicht lesbar (kein gültiges JSON).
Das gespeicherte Secret lässt sich auf diesem System nicht entschlüsseln, etwa nach einer Kopie von einem anderen System.

Bis Sie die Werte eingetragen und gespeichert haben, gilt ONLYOFFICE als nicht eingerichtet.

Limits und Empfehlungen

ONLYOFFICE ist im Standard so eingestellt, dass die maximale Dateigröße 100 MB ist. Größere Dokumente können nicht geladen werden.

Verwenden Sie die neueren Office-Formate, da diese kleiner und kompatibler mit ONLYOFFICE sind:

docx (statt doc)
xlsx (statt xls)
pptx (statt ppt)

PDF-Dokumente öffnet agorum core nicht mit ONLYOFFICE.

ONLYOFFICE in der Cloud verwenden

Sofern ONLYOFFICE in einer Cloud betrieben wird und agorum core in Ihrem internen Netz liegt, benötigt ONLYOFFICE Zugriff über HTTPS auf agorum core. D. h. agorum core muss aus dem Internet heraus erreichbar sein oder zumindest vom ONLYOFFICE-Cloud-Server aus.

Verwenden Sie einen Proxyserver, der bestimmte Bestandteile von agorum core ins Internet veröffentlicht. Tipps, wie Sie solch eine Konfiguration aufbauen, können Sie im Internet nachlesen.

Sie müssen nicht den gesamten agorum core Server ins Internet stellen. Folgende URLs genügen:

/api/rest/custom/onlyoffice.download.noauth/*
/api/rest/custom/onlyoffice.noauth/*

Gängige Open-Source-Proxyserver, die Sie einsetzen können:

NGINX
Apache
HAProxy

Achtung: Sicherheitsrisiko durch falsche Konfiguration. Verwenden Sie für den internen agorum core Webserver keine einfache Portweiterleitung.

Wenn Sie Probleme mit ONLYOFFICE haben

Prüfen Sie zuerst die Verbindung mit Verbindung prüfen. Die Meldungen der Prüfung nennen in den meisten Fällen die Ursache.

Der Menüeintrag oder die Maske ist nicht verfügbar

Beschreibung des Problems

Der Menüeintrag ONLYOFFICE Verbindung einrichten fehlt, oder beim Öffnen der Maske erscheint die Meldung Die Verbindung zu ONLYOFFICE kann nur ein Administrator einrichten und prüfen. und die Maske schließt sich.

Ursache

Sie sind nicht als Administrator angemeldet.

Lösung

Melden Sie sich als Administrator an (im Benutzermenü Als Administrator anmelden).

Kein Zugriff auf diese Datei möglich

Beschreibung des Problems

Beim Zugriff von ONLYOFFICE auf den agorum core Server erscheint in ONLYOFFICE die Meldung Kein Zugriff auf diese Datei möglich.

Ursache

ONLYOFFICE erreicht agorum core unter der agorum core URL nicht, meist weil die Adresse nicht korrekt ist.

Lösung

Tragen Sie die korrekte agorum core URL ein und prüfen Sie den Schritt ONLYOFFICE → agorum core (Rückweg) mit Verbindung prüfen.

Sicherheitstoken des Dokuments ist nicht korrekt

Beschreibung des Problems

Beim Zugriff von ONLYOFFICE auf den agorum core-Server erscheint in ONLYOFFICE die Meldung Sicherheitstoken des Dokuments ist nicht korrekt. Wenden Sie sich an Ihren Serveradministrator.

Ursache

Der ONLYOFFICE Dokumentenserver Secret oder Token (JWT) ist nicht korrekt.

Lösung

Tragen Sie den korrekten ONLYOFFICE Dokumentenserver "Secret" oder "Token" (JWT) ein. Der Schritt Secret von Verbindung prüfen zeigt, ob es passt.

Ansicht bleibt bei Klick auf ein Office-Dokument leer oder es erscheint eine Fehlermeldung

Beschreibung des Problems

In agorum core bleibt die Registerkarte Ansicht bei Klick auf ein Office-Dokument leer, oder es wird eine Fehlermeldung angezeigt.

Ansicht bleibt bei Klick auf Office-Dokument leer

Ursachen

Die Adresse des ONLYOFFICE-Servers ist falsch.
Der Browser erreicht den ONLYOFFICE-Server nicht.
Die Benutzer rufen agorum core über HTTPS auf, ONLYOFFICE aber über HTTP.

Lösungen

Tragen Sie die korrekte Adresse des ONLYOFFICE-Servers ein.
Öffnen Sie im Browser des Benutzers den Link <ONLYOFFICE Documentserver URL>/healthcheck aus dem Ergebnis von Verbindung prüfen. Erscheint nicht true, prüfen Sie den ONLYOFFICE-Server und das Netzwerk.
Machen Sie ONLYOFFICE über HTTPS erreichbar.

ONLYOFFICE ist nicht eingerichtet

Beschreibung des Problems

Die Registerkarte Ansicht zeigt ONLYOFFICE ist noch nicht eingerichtet, oder die ONLYOFFICE-Aktionen melden ONLYOFFICE ist nicht eingerichtet, obwohl eine Verbindung gespeichert war.

Ursache

Die gespeicherte Konfiguration ist nicht lesbar, oder das Secret lässt sich auf diesem System nicht entschlüsseln, etwa nach einer Kopie von einem anderen System.

Lösung

Öffnen Sie ONLYOFFICE Verbindung einrichten, tragen Sie die Werte ein und speichern Sie (siehe So wird die Verbindung gespeichert).