Zum Hauptinhalt springen

ONLYOFFICE Apps in Docker ausführen

Einleitung​

ONLYOFFICE Apps ist ein Dokumenten-Hub, in dem Sie Benutzer und Dokumente an einem Ort zusammenbringen können, um die Zusammenarbeit zu verbessern.

Diese Anleitung zeigt Ihnen, wie Sie ONLYOFFICE Apps mit Docker auf Ihrem Computer ausführen.

hinweis

Diese Anleitung stellt einen Entwicklungs-/Test-Build von ONLYOFFICE Apps bereit und ist nicht für den Produktivbetrieb gedacht. Dieser Build läuft ausschließlich über einfaches HTTP, wird ohne Identity-/OAuth-Dienste ausgeliefert und bietet einen reduzierten Funktionsumfang. Verwenden Sie für Produktivumgebungen die Produktionsversion von ONLYOFFICE Apps.

Überblick​

Im Gegensatz zur standardmäßigen Multi-Container-Bereitstellung führt dieser Build alle ONLYOFFICE Apps-Dienste in einem einzigen Container aus, statt in separaten Containern pro Dienst. Der gesamte Stack besteht aus den folgenden Containern:

ContainerRolle
onlyoffice-appsAlle ONLYOFFICE Apps-Dienste (zusammengefasst)
onlyoffice-document-serverDocument Server (Editoren)
onlyoffice-mysql-serverMySQL-Datenbank
onlyoffice-opensearchOpenSearch

Im Vergleich zur standardmäßigen Multi-Container-Bereitstellung unterscheidet sich dieser Build in folgenden Punkten:

  • Alle ONLYOFFICE Apps-Dienste sind in einem einzigen Container zusammengefasst.
  • Vereinfachte Suche.
  • Keine Vorschaubilderzeugung.
  • Nur HTTP, keine TLS/HTTPS-Unterstützung ab Werk.
  • Keine Identity-/OAuth-Dienste.

Systemanforderungen​

  • CPU: mindestens 6 Kerne (8 Kerne empfohlen)
  • RAM: mindestens 12 GB (16 GB empfohlen)
  • HDD: mindestens 40 GB freier Speicherplatz
  • Betriebssystem: amd64-Linux-Distribution mit Kernel-Version 3.10 oder höher
  • Zusätzliche Anforderungen:
    • mindestens 6 GB Swap
    • Docker Engine mit dem Compose-Plugin (Befehl docker compose)

Repository klonen​

Klonen Sie das Repository DocSpace-buildtools mit dem folgenden Befehl:

git clone https://github.com/ONLYOFFICE/DocSpace-buildtools.git

Wechseln Sie nach dem Klonen des Repositorys in das Compose-Verzeichnis:

cd DocSpace-buildtools/install/docker/community

Vorgefertigte Images ausführen​

Um ONLYOFFICE Apps mit den vorgefertigten Images im Hintergrundmodus zu starten, führen Sie den folgenden Befehl aus:

docker compose up -d

Sobald die Container laufen, öffnen Sie einen Browser und geben Sie http://localhost oder http://your-ip-address in die Adressleiste ein, um auf ONLYOFFICE Apps zuzugreifen.

Images aus dem Quellcode erstellen​

Verwenden Sie diese Option, wenn Sie die ONLYOFFICE Apps-Images selbst erstellen oder Änderungen aus einem bestimmten Branch testen möchten.

Erstellen und starten Sie die Container mit dem folgenden Befehl:

docker compose up -d --build
hinweis

Standardmäßig werden die Images aus dem Branch master erstellt. Um aus einem anderen Branch zu erstellen, geben Sie das Build-Argument GIT_BRANCH an: GIT_BRANCH=your-branch docker compose up -d --build.

Sobald der Build abgeschlossen ist und die Container laufen, öffnen Sie http://localhost oder http://your-ip-address in Ihrem Browser, um auf ONLYOFFICE Apps zuzugreifen.

Mit SSL ausführen​

ONLYOFFICE Apps unterstützt sowohl Let's Encrypt als auch benutzerdefinierte SSL-Zertifikate.

Ein Let's Encrypt-Zertifikat verwenden​

Um ONLYOFFICE Apps mit einem Let's Encrypt-Zertifikat auszuführen, führen Sie den folgenden Befehl aus und geben Sie Ihre eigene Domain, E-Mail-Adresse und Arbeitsbereichs-URL an:

SSL_MODE="letsencrypt" \
SSL_DOMAIN="example.com,portal.example.com,api.example.com" \
SSL_EMAIL="admin@example.com" \
APP_URL_PORTAL="https://example.com/" \
docker compose \
  -f docker-compose.yml \
  -f ssl.yml \
  up -d

Die folgenden Parameter werden verwendet:

  • SSL_MODE – der Modus des SSL-Zertifikats.
  • SSL_DOMAIN – eine oder mehrere durch Kommas getrennte Domains.
  • SSL_EMAIL – die E-Mail-Adresse für die Registrierung bei Let's Encrypt.
  • APP_URL_PORTAL – die öffentliche HTTPS-URL Ihres Arbeitsbereichs.

Ein benutzerdefiniertes Zertifikat oder ein Zertifikat einer privaten CA verwenden​

Wenn Sie ein selbstsigniertes Zertifikat oder ein von einer privaten Zertifizierungsstelle (CA) ausgestelltes Zertifikat verwenden, muss auch der ONLYOFFICE Document Server diesem Zertifikat vertrauen.

Entfernen Sie in der Datei docker-compose.yml die Kommentarzeichen vor dem folgenden Volume:

services:
   onlyoffice-document-server:
     volumes:
       - ${CERTIFICATE_PATH}:/var/www/onlyoffice/Data/certs/extra-ca-certs.pem

Geben Sie dann den Zertifikatspfad auf dem Host an und führen Sie den folgenden Befehl aus:

SSL_MODE="custom" \
SSL_DOMAIN="example.com" \
SSL_CERT_PATH="/etc/nginx/certs/fullchain.crt" \
SSL_KEY_PATH="/etc/nginx/certs/private.key" \
CERTIFICATE_PATH="./config/nginx/certs/fullchain.crt" \
APP_URL_PORTAL="https://example.com/" \
docker compose \
  -f docker-compose.yml \
  -f ssl.yml \
  up -d
hinweis

CERTIFICATE_PATH muss auf die Zertifikatsdatei auf dem Docker-Host verweisen, nicht auf den Pfad innerhalb des Containers. Diese Option ist in der Regel nur für selbstsignierte Zertifikate oder von einer privaten CA ausgestellte Zertifikate erforderlich. Zertifikate öffentlicher CAs (zum Beispiel Let's Encrypt, DigiCert oder GoDaddy) erfordern normalerweise keine zusätzliche Konfiguration.

Die folgenden Parameter werden verwendet:

  • SSL_MODE – der Modus des SSL-Zertifikats (custom).
  • SSL_DOMAIN – der Domainname des Arbeitsbereichs.
  • SSL_CERT_PATH – der Pfad zum SSL-Zertifikat.
  • SSL_KEY_PATH – der Pfad zum privaten Schlüssel.
  • APP_URL_PORTAL – die öffentliche HTTPS-URL Ihres Arbeitsbereichs.
hinweis

Standardmäßig bindet die Konfiguration ssl.yml das lokale Verzeichnis ./config/nginx/certs in den Container unter /etc/nginx/certs ein.

Sobald die Container laufen, öffnen Sie die Adresse Ihres Arbeitsbereichs, zum Beispiel https://example.com/, in einem Browser, um auf ONLYOFFICE Apps zuzugreifen.