Aller au contenu principal

Lancer ONLYOFFICE Apps sous Docker

Introduction​

ONLYOFFICE Apps est un hub de documents qui vous permet de connecter utilisateurs et documents en un seul endroit pour favoriser la collaboration.

Ce guide vous explique comment exécuter ONLYOFFICE Apps sur votre machine à l'aide de Docker.

remarque

Ce guide déploie une version de développement/test d'ONLYOFFICE Apps et n'est pas destiné à une utilisation en production. Cette version fonctionne uniquement via HTTP, ne dispose pas de services d'identité/OAuth et propose un ensemble de fonctionnalités réduit. Pour les déploiements en production, utilisez la version de production d'ONLYOFFICE Apps.

Vue d'ensemble​

Contrairement au déploiement standard multi-conteneurs, cette version exécute tous les services d'ONLYOFFICE Apps dans un seul conteneur au lieu de conteneurs distincts par service. La pile complète se compose des conteneurs suivants :

ConteneurRôle
onlyoffice-appsTous les services d'ONLYOFFICE Apps (consolidés)
onlyoffice-document-serverServeur de documents (éditeurs)
onlyoffice-mysql-serverBase de données MySQL
onlyoffice-opensearchOpenSearch

Par rapport au déploiement standard multi-conteneurs, cette version présente les différences suivantes :

  • Tous les services d'ONLYOFFICE Apps sont consolidés dans un seul conteneur.
  • Recherche simplifiée.
  • Pas de génération de vignettes.
  • HTTP uniquement, sans prise en charge TLS/HTTPS par défaut.
  • Pas de services d'identité/OAuth.

Configuration système requise​

  • Processeur : au moins 6 cœurs (8 cœurs recommandés)
  • RAM : au moins 12 Go (16 Go recommandés)
  • Disque dur : au moins 40 Go d'espace libre
  • Système d'exploitation : distribution Linux amd64 avec la version de noyau 3.10 ou ultérieure
  • Exigences supplémentaires :
    • au moins 6 Go de swap
    • Docker Engine avec le module Compose (commande docker compose)

Cloner le dépôt​

Clonez le dépôt DocSpace-buildtools à l'aide de la commande suivante :

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

Une fois le dépôt cloné, accédez au répertoire Compose :

cd DocSpace-buildtools/install/docker/community

Lancer les images précompilées​

Pour démarrer ONLYOFFICE Apps en mode détaché à l'aide des images précompilées, exécutez la commande suivante :

docker compose up -d

Une fois les conteneurs démarrés, ouvrez un navigateur et saisissez http://localhost ou http://your-ip-address dans la barre d'adresse pour accéder à ONLYOFFICE Apps.

Compilation des images depuis la source​

Utilisez cette option si vous souhaitez compiler vous-même les images d'ONLYOFFICE Apps ou tester des modifications depuis une branche spécifique.

Compilez et démarrez les conteneurs à l'aide de la commande suivante :

docker compose up -d --build
remarque

Par défaut, les images sont compilées depuis la branche master. Pour compiler depuis une autre branche, spécifiez l'argument de compilation GIT_BRANCH : GIT_BRANCH=your-branch docker compose up -d --build.

Une fois la compilation terminée et les conteneurs démarrés, ouvrez http://localhost ou http://your-ip-address dans votre navigateur pour accéder à ONLYOFFICE Apps.

Exécution avec SSL​

ONLYOFFICE Apps prend en charge les certificats Let's Encrypt et les certificats SSL personnalisés.

Utilisation d'un certificat Let's Encrypt​

Pour exécuter ONLYOFFICE Apps avec un certificat Let's Encrypt, exécutez la commande suivante en spécifiant votre propre domaine, adresse e-mail et URL de portail :

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

Les paramètres suivants sont utilisés :

  • SSL_MODE – le mode de certificat SSL.
  • SSL_DOMAIN – un ou plusieurs domaines séparés par des virgules.
  • SSL_EMAIL – l'adresse e-mail utilisée pour l'enregistrement Let's Encrypt.
  • APP_URL_PORTAL – l'URL HTTPS publique de votre portail.

Utilisation d'un certificat CA personnalisé ou privé​

Si vous utilisez un certificat auto-signé ou un certificat émis par une Autorité de Certification (CA) privée, le Serveur de documents ONLYOFFICE doit également approuver ce certificat.

Décommentez le volume suivant dans le fichier docker-compose.yml :

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

Indiquez ensuite le chemin du certificat sur l'hôte et exécutez la commande suivante :

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
remarque

CERTIFICATE_PATH doit pointer vers le fichier de certificat sur l'hôte Docker, et non vers le chemin à l'intérieur du conteneur. Cette option n'est généralement requise que pour les certificats auto-signés ou les certificats émis par une CA privée. Les certificats émis par des CA publiques (par exemple, Let's Encrypt, DigiCert ou GoDaddy) ne nécessitent généralement pas cette configuration supplémentaire.

Les paramètres suivants sont utilisés :

  • SSL_MODE – le mode de certificat SSL (custom).
  • SSL_DOMAIN – le nom de domaine du portail.
  • SSL_CERT_PATH – le chemin vers le certificat SSL.
  • SSL_KEY_PATH – le chemin vers la clé privée.
  • APP_URL_PORTAL – l'URL HTTPS publique de votre portail.
remarque

Par défaut, la configuration ssl.yml monte le répertoire local ./config/nginx/certs dans /etc/nginx/certs à l'intérieur du conteneur.

Une fois les conteneurs démarrés, ouvrez l'adresse de votre portail, par exemple https://example.com/, dans un navigateur pour accéder à ONLYOFFICE Apps.