Pular para o conteúdo principal

Executando o ONLYOFFICE Apps no Docker

Introdução​

O ONLYOFFICE Apps é um hub de documentos onde você pode conectar usuários e documentos em um só lugar para impulsionar a colaboração.

Este guia mostrará como executar o ONLYOFFICE Apps na sua máquina usando o Docker.

observação

Este guia implanta uma versão de desenvolvimento/teste do ONLYOFFICE Apps e não se destina ao uso em produção. Esta versão funciona apenas por HTTP simples, é fornecida sem serviços de identidade/OAuth e executa um conjunto reduzido de recursos. Para implantações em produção, use a versão de produção do ONLYOFFICE Apps.

Visão geral​

Ao contrário da implantação padrão com vários contêineres, esta versão executa todos os serviços do ONLYOFFICE Apps dentro de um único contêiner, em vez de contêineres separados por serviço. A pilha completa consiste nos seguintes contêineres:

ContêinerFunção
onlyoffice-appsTodos os serviços do ONLYOFFICE Apps (consolidados)
onlyoffice-document-serverDocument Server (editores)
onlyoffice-mysql-serverBanco de dados MySQL
onlyoffice-opensearchOpenSearch

Em comparação com a implantação padrão com vários contêineres, esta versão tem as seguintes diferenças:

  • Todos os serviços do ONLYOFFICE Apps são consolidados em um único contêiner.
  • Pesquisa simplificada.
  • Sem geração de miniaturas.
  • Somente HTTP, sem suporte a TLS/HTTPS de fábrica.
  • Sem serviços de identidade/OAuth.

Requisitos do sistema​

  • CPU: pelo menos 6 núcleos (8 núcleos recomendados)
  • RAM: pelo menos 12 GB (16 GB recomendados)
  • HDD: pelo menos 40 GB de espaço livre
  • SO: distribuição Linux amd64 com versão do kernel 3.10 ou posterior
  • Requisitos adicionais:
    • pelo menos 6 GB de swap
    • Docker Engine com o plugin Compose (comando docker compose)

Clonando o repositório​

Clone o repositório DocSpace-buildtools usando o seguinte comando:

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

Depois que o repositório for clonado, acesse o diretório do Compose:

cd DocSpace-buildtools/install/docker/community

Executando imagens pré-construídas​

Para iniciar o ONLYOFFICE Apps em modo desanexado usando as imagens pré-construídas, execute o seguinte comando:

docker compose up -d

Quando os contêineres estiverem em execução, abra um navegador e digite http://localhost ou http://your-ip-address na barra de endereços para acessar o ONLYOFFICE Apps.

Construindo imagens a partir do código-fonte​

Use esta opção se quiser construir você mesmo as imagens do ONLYOFFICE Apps ou testar alterações de uma branch específica.

Construa e inicie os contêineres usando o seguinte comando:

docker compose up -d --build
observação

Por padrão, as imagens são construídas a partir da branch master. Para construir a partir de outra branch, especifique o argumento de build GIT_BRANCH: GIT_BRANCH=your-branch docker compose up -d --build.

Quando a construção for concluída e os contêineres estiverem em execução, abra http://localhost ou http://your-ip-address no seu navegador para acessar o ONLYOFFICE Apps.

Executando com SSL​

O ONLYOFFICE Apps oferece suporte tanto a certificados Let's Encrypt quanto a certificados SSL personalizados.

Usando um certificado Let's Encrypt​

Para executar o ONLYOFFICE Apps com um certificado Let's Encrypt, execute o seguinte comando, especificando seu próprio domínio, e-mail e URL do espaço de trabalho:

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

Os seguintes parâmetros são usados:

  • SSL_MODE – o modo do certificado SSL.
  • SSL_DOMAIN – um ou mais domínios separados por vírgulas.
  • SSL_EMAIL – o endereço de e-mail usado para o registro no Let's Encrypt.
  • APP_URL_PORTAL – a URL HTTPS pública do seu espaço de trabalho.

Usando um certificado personalizado ou de uma CA privada​

Se você estiver usando um certificado autoassinado ou um certificado emitido por uma Autoridade de Certificação (CA) privada, o ONLYOFFICE Document Server também deve confiar nesse certificado.

Remova o comentário do seguinte volume no arquivo docker-compose.yml:

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

Em seguida, especifique o caminho do certificado no host e execute o seguinte 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
observação

CERTIFICATE_PATH deve apontar para o arquivo do certificado no host do Docker, e não para o caminho dentro do contêiner. Esta opção geralmente só é necessária para certificados autoassinados ou emitidos por uma CA privada. Certificados emitidos por CAs públicas (por exemplo, Let's Encrypt, DigiCert ou GoDaddy) geralmente não exigem essa configuração adicional.

Os seguintes parâmetros são usados:

  • SSL_MODE – o modo do certificado SSL (custom).
  • SSL_DOMAIN – o nome de domínio do espaço de trabalho.
  • SSL_CERT_PATH – o caminho do certificado SSL.
  • SSL_KEY_PATH – o caminho da chave privada.
  • APP_URL_PORTAL – a URL HTTPS pública do seu espaço de trabalho.
observação

Por padrão, a configuração ssl.yml monta o diretório local ./config/nginx/certs em /etc/nginx/certs dentro do contêiner.

Quando os contêineres estiverem em execução, abra o endereço do seu espaço de trabalho, por exemplo https://example.com/, em um navegador para acessar o ONLYOFFICE Apps.