Saltar al contenido principal

Ejecutar ONLYOFFICE Apps en Docker

Introducción​

ONLYOFFICE Apps es un centro de documentos donde puede reunir a usuarios y documentos en un solo lugar para mejorar la colaboración.

Esta guía le mostrará cómo ejecutar ONLYOFFICE Apps en su máquina con Docker.

nota

Esta guía despliega una compilación de desarrollo/pruebas de ONLYOFFICE Apps y no está pensada para uso en producción. Esta compilación funciona únicamente por HTTP simple, se entrega sin servicios de identidad/OAuth y ofrece un conjunto reducido de funciones. Para implementaciones de producción, utilice la versión de producción de ONLYOFFICE Apps.

Descripción general​

A diferencia de la implementación estándar de varios contenedores, esta compilación ejecuta todos los servicios de ONLYOFFICE Apps dentro de un único contenedor en lugar de contenedores separados por servicio. La pila completa consta de los siguientes contenedores:

ContenedorFunción
onlyoffice-appsTodos los servicios de ONLYOFFICE Apps (consolidados)
onlyoffice-document-serverDocument Server (editores)
onlyoffice-mysql-serverBase de datos MySQL
onlyoffice-opensearchOpenSearch

En comparación con la implementación estándar de varios contenedores, esta compilación tiene las siguientes diferencias:

  • Todos los servicios de ONLYOFFICE Apps están consolidados en un único contenedor.
  • Búsqueda simplificada.
  • Sin generación de miniaturas.
  • Solo HTTP, sin compatibilidad con TLS/HTTPS de fábrica.
  • Sin servicios de identidad/OAuth.

Requisitos del sistema​

  • CPU: al menos 6 núcleos (se recomiendan 8 núcleos)
  • RAM: al menos 12 GB (se recomiendan 16 GB)
  • HDD: al menos 40 GB de espacio libre
  • SO: distribución Linux amd64 con la versión del kernel 3.10 o posterior
  • Requisitos adicionales:
    • al menos 6 GB de swap
    • Docker Engine con el complemento Compose (comando docker compose)

Clonar el repositorio​

Clone el repositorio DocSpace-buildtools con el siguiente comando:

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

Una vez clonado el repositorio, cambie al directorio de Compose:

cd DocSpace-buildtools/install/docker/community

Ejecutar imágenes precompiladas​

Para iniciar ONLYOFFICE Apps en modo desacoplado con las imágenes precompiladas, ejecute el siguiente comando:

docker compose up -d

Una vez que los contenedores estén en funcionamiento, abra un navegador e introduzca http://localhost o http://your-ip-address en la barra de direcciones para acceder a ONLYOFFICE Apps.

Compilar imágenes desde el código fuente​

Utilice esta opción si desea compilar usted mismo las imágenes de ONLYOFFICE Apps o probar cambios de una rama específica.

Compile e inicie los contenedores con el siguiente comando:

docker compose up -d --build
nota

De forma predeterminada, las imágenes se compilan desde la rama master. Para compilar desde otra rama, especifique el argumento de compilación GIT_BRANCH: GIT_BRANCH=your-branch docker compose up -d --build.

Una vez finalizada la compilación y con los contenedores en funcionamiento, abra http://localhost o http://your-ip-address en su navegador para acceder a ONLYOFFICE Apps.

Ejecutar con SSL​

ONLYOFFICE Apps admite tanto certificados de Let's Encrypt como certificados SSL personalizados.

Usar un certificado de Let's Encrypt​

Para ejecutar ONLYOFFICE Apps con un certificado de Let's Encrypt, ejecute el siguiente comando indicando su propio dominio, correo electrónico y URL del espacio de trabajo:

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

Se utilizan los siguientes parámetros:

  • SSL_MODE – el modo del certificado SSL.
  • SSL_DOMAIN – uno o varios dominios separados por comas.
  • SSL_EMAIL – la dirección de correo electrónico utilizada para el registro en Let's Encrypt.
  • APP_URL_PORTAL – la URL HTTPS pública de su espacio de trabajo.

Usar un certificado personalizado o de una CA privada​

Si utiliza un certificado autofirmado o un certificado emitido por una autoridad de certificación (CA) privada, ONLYOFFICE Document Server también debe confiar en este certificado.

Quite el comentario del siguiente volumen en el archivo docker-compose.yml:

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

A continuación, especifique la ruta del certificado en el host y ejecute el siguiente comando:

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
nota

CERTIFICATE_PATH debe apuntar al archivo del certificado en el host de Docker, no a la ruta dentro del contenedor. Esta opción normalmente solo es necesaria para certificados autofirmados o emitidos por una CA privada. Los certificados emitidos por CA públicas (por ejemplo, Let's Encrypt, DigiCert o GoDaddy) normalmente no requieren esta configuración adicional.

Se utilizan los siguientes parámetros:

  • SSL_MODE – el modo del certificado SSL (custom).
  • SSL_DOMAIN – el nombre de dominio del espacio de trabajo.
  • SSL_CERT_PATH – la ruta del certificado SSL.
  • SSL_KEY_PATH – la ruta de la clave privada.
  • APP_URL_PORTAL – la URL HTTPS pública de su espacio de trabajo.
nota

De forma predeterminada, la configuración ssl.yml monta el directorio local ./config/nginx/certs en /etc/nginx/certs dentro del contenedor.

Una vez que los contenedores estén en funcionamiento, abra la dirección de su espacio de trabajo, por ejemplo https://example.com/, en un navegador para acceder a ONLYOFFICE Apps.