Como instalar o ONLYOFFICE Apps Community com parâmetros de script
Introdução
O ONLYOFFICE Apps Community é uma versão gratuita de um hub de documentos onde você pode conectar usuários e documentos em um único lugar para impulsionar a colaboração.
O ONLYOFFICE Apps Community é distribuído como um script de instalação automática para sistemas operacionais Linux com Docker instalado. O script configurará contêineres Docker com todos os componentes necessários para o funcionamento correto do ONLYOFFICE Apps Community e é fácil de executar, gerenciar e atualizar.
Depois de baixar o script de instalação do ONLYOFFICE Apps Community, talvez seja necessário executá-lo especificando alguns parâmetros adicionais, por exemplo, se você quiser instalar cada componente em uma máquina separada.
Use o seguinte comando para exibir a lista de todos os parâmetros Docker disponíveis do script:
bash apps-install.sh docker -h
Use o seguinte comando para exibir a lista de todos os parâmetros DEB/RPM disponíveis do script:
bash apps-install.sh package -h
Abaixo você encontra uma breve descrição e alguns exemplos de uso desses parâmetros.
Ao executar o script com parâmetros, você será solicitado a selecionar a forma como deseja instalar o ONLYOFFICE Apps. Digite Y e pressione Enter para instalar o ONLYOFFICE Apps usando Docker. Digite N e pressione Enter para instalar o ONLYOFFICE Apps a partir de pacotes DEB/RPM.
Credenciais
| Parâmetro | Descrição |
|---|---|
-reg, --registry | URL do registro do Docker (por exemplo, https://myregistry.com:5000) |
-un, --username | login do registro do Docker |
-p, --password | senha do registro do Docker |
Esses parâmetros são usados caso forneçamos credenciais para acessar um repositório de teste, para que você possa executar contêineres a partir das imagens armazenadas nele.
Exemplo
bash apps-install.sh -reg URL -un username -p password
Tipo de instalação
| Parâmetro | Descrição | Valores | Padrão |
|---|---|---|---|
-it, --installationtype | tipo de instalação | community|developer|enterprise | community |
Esse parâmetro permite instalar a solução especificada: ONLYOFFICE Apps Community, ONLYOFFICE Apps Developer ou ONLYOFFICE Apps Enterprise.
Exemplo
bash apps-install.sh -it enterprise
Isso instalará a solução ONLYOFFICE Apps Enterprise.
Verificação de hardware
| Parâmetro | Descrição | Valores | Padrão |
|---|---|---|---|
-skiphc, --skiphardwarecheck | use para ignorar a verificação de hardware | true|false | false |
Esse parâmetro permite ignorar a verificação de se o sistema atende aos requisitos mínimos de hardware.
Exemplo
bash apps-install.sh -skiphc true
Isso ignorará a verificação de hardware.
Atualização de componentes
| Parâmetro | Descrição | Valores | Padrão |
|---|---|---|---|
-u, --update | use para atualizar componentes existentes | true|false | false |
Esse parâmetro permite instalar as versões mais recentes dos componentes necessários se os componentes correspondentes instalados em sua máquina estiverem desatualizados.
Exemplo
bash apps-install.sh -u true
Isso interromperá sucessivamente os contêineres que precisam ser atualizados, os removerá e, em seguida, executará as versões mais recentes dos componentes correspondentes do ONLYOFFICE Apps Community. Se a versão atual do componente coincidir com a mais recente disponível, esse contêiner não será afetado. Se você ignorou alguns componentes durante a instalação anterior, eles também serão ignorados. Os dados do ONLYOFFICE Apps devem ser detectados automaticamente.
Atualizar apenas o Docs para a versão 7.2.1.34 e ignorar a atualização de todos os outros componentes:
bash apps-install.sh -u true -docsi onlyoffice/documentserver -docsv 7.2.1.34 -idocs true -ia false -irbt false -irds false
Atualizar apenas o ONLYOFFICE Apps para a versão 1.2.0 e ignorar a atualização de todos os outros componentes:
bash apps-install.sh -u true -asv v1.2.0 -idocs false -irbt false -irds false
Instalação de componentes
| Parâmetro | Descrição | Valores | Padrão |
|---|---|---|---|
-ia, --installapps | instalar o ONLYOFFICE Apps | true|false | true |
-idocs, --installdocs | instalar o ONLYOFFICE Docs | true|false | true |
-irbt, --installrabbitmq | instalar o RabbitMQ | true|false | true |
-irds, --installredis | instalar o Redis | true|false | true |
-imysql, --installmysql | instalar o MySQL | true|false | true |
Esses parâmetros permitem especificar se você precisa ou não instalar um determinado componente. Eles podem ser usados se você quiser instalar cada componente em uma máquina separada.
- Use o valor
truepara instalar um componente. - Use o valor
falsepara ignorar a instalação de um componente.
Exemplo
bash apps-install.sh -idocs false
Isso instalará todos os componentes do ONLYOFFICE Apps Community sem o ONLYOFFICE Docs.
bash apps-install.sh -ia false -idocs true -imysql false -irbt false -irds false
Isso ignorará a instalação do ONLYOFFICE Apps, do MySQL, do RabbitMQ e do Redis e instalará apenas o ONLYOFFICE Docs.
Versão do componente
| Parâmetro | Descrição |
|---|---|
-asv, --appsversion | versão do ONLYOFFICE Apps |
-docsv, --docsversion | versão do ONLYOFFICE Docs |
Esses parâmetros podem ser usados para instalar uma determinada versão do ONLYOFFICE Apps ou do ONLYOFFICE Docs se, por algum motivo, você não quiser instalar a versão mais recente disponível no repositório. Por padrão, uma imagem marcada como latest é usada para executar o contêiner do componente.
Exemplo
Abra o repositório do Docker Hub no navegador, selecione o ONLYOFFICE Docs e vá para a guia Tags para ver todas as tags disponíveis no repositório. Especifique a versão que deseja instalar:
bash apps-install.sh -docsv 7.2.1.34
Isso instalará o ONLYOFFICE Apps com a versão 7.2.1.34 do ONLYOFFICE Docs.
Nome da imagem do ONLYOFFICE Docs
| Parâmetro | Descrição |
|---|---|
-docsi, --docsimage | nome da imagem do ONLYOFFICE Docs |
Esse parâmetro pode ser usado para especificar o nome da imagem do ONLYOFFICE Docs a partir da qual um contêiner deve ser iniciado. A imagem especificada deve estar armazenada em nosso repositório público oficial no Docker Hub.
Exemplo
bash apps-install.sh -docsi onlyoffice/documentserver
Isso executará um contêiner a partir da imagem do ONLYOFFICE Docs especificada e armazenada no repositório.
Configuração para hosts
| Parâmetro | Descrição |
|---|---|
-ash, --appshost | host do ONLYOFFICE Apps |
-esh, --elastichost | hosts do OpenSearch |
Esses parâmetros podem ser usados para conectar os componentes se você os instalar em máquinas separadas.
Exemplo
bash apps-install.sh -esh 192.168.3.202
Isso instalará o ONLYOFFICE Apps e o conectará ao OpenSearch instalado em outra máquina com o endereço IP 192.168.3.202.
Configuração para core.machinekey
| Parâmetro | Descrição |
|---|---|
-mk, --machinekey | Configuração da chave core.machinekey |
Esse parâmetro permite especificar sua própria machinekey ao instalar o ONLYOFFICE Apps Community.
Esse parâmetro é gravado no arquivo de configuração /app/onlyoffice/config/appsettings.json (o caminho é especificado dentro do contêiner onlyoffice-studio).
Exemplo
bash apps-install.sh -mk yourmachinekey
Porta externa do ONLYOFFICE Apps
| Parâmetro | Descrição | Padrão |
|---|---|---|
-ep, --externalport | porta externa do ONLYOFFICE Apps | 80 |
Esse parâmetro permite alterar a porta na qual o ONLYOFFICE Apps será executado. Por padrão, a porta 80 é usada.
Exemplo
bash apps-install.sh -ep 8080
Configurações para cabeçalho e segredo JWT
| Parâmetro | Descrição |
|---|---|
-jh, --jwtheader | Configuração do cabeçalho JWT |
-js, --jwtsecret | Configuração da chave secreta JWT |
Esses parâmetros permitem especificar o cabeçalho JWT e sua própria chave secreta JWT ao instalar o ONLYOFFICE Apps Community. O cabeçalho JWT define o cabeçalho http que será usado para enviar o JWT. A chave secreta é usada para assinar o token web JSON e validar o token na solicitação ao ONLYOFFICE Docs.
Esses parâmetros são gravados nos seguintes arquivos de configuração (os caminhos são especificados dentro dos contêineres onlyoffice-studio e onlyoffice-document-server):
- Para o ONLYOFFICE Apps -
/app/onlyoffice/config/appsettings.json - Para o Document Server -
/etc/onlyoffice/documentserver/local.json
Exemplo
bash apps-install.sh -js yoursecret
Servidor MySQL
| Parâmetro | Descrição | Padrão |
|---|---|---|
-mysqlrp, --mysqlrootpassword | senha root do servidor MySQL | gerada automaticamente |
-mysqlh, --mysqlhost | host do servidor MySQL | localhost |
-mysqlport, --mysqlport | número da porta do servidor MySQL | 3306 |
Se você não especificar explicitamente o host e a porta, os valores padrão serão usados. A senha de root é gerada automaticamente se você não a definir.
Exemplo
bash apps-install.sh -mysqlrp new-secret-pw
Esse comando permite definir sua própria senha para a conta root do MySQL durante a instalação do ONLYOFFICE Apps Community.
Banco de dados do ONLYOFFICE Apps
| Parâmetro | Descrição | Padrão |
|---|---|---|
-mysqld, --mysqldatabase | nome do banco de dados do ONLYOFFICE Apps | onlyoffice_apps |
-mysqlu, --mysqluser | usuário do banco de dados do ONLYOFFICE Apps | - |
-mysqlp, --mysqlpassword | senha do banco de dados do ONLYOFFICE Apps | gerada automaticamente |
Esses parâmetros permitem criar o banco de dados do ONLYOFFICE Apps especificando um nome de banco de dados personalizado, bem como um nome de usuário e uma senha para a conta com permissões de superusuário no banco de dados criado. Se você não especificar explicitamente o nome do banco de dados, o valor padrão será usado. Se você não definir uma senha, ela será gerada automaticamente.
Exemplo
bash apps-install.sh -mysqld appsdatabase -mysqlu username -mysqlp password
Servidor RabbitMQ
| Parâmetro | Descrição | Padrão |
|---|---|---|
--rabbitmqprotocol | protocolo de conexão do RabbitMQ | amqp |
--rabbitmqhost | host do servidor RabbitMQ | localhost |
--rabbitmqport | número da porta do servidor RabbitMQ | 5672 |
--rabbitmqusername | nome de usuário do RabbitMQ | - |
--rabbitmqpassword | senha do usuário do RabbitMQ | - |
--rabbitmqvirtualhost | host virtual do RabbitMQ | / |
Use esses parâmetros para conectar o ONLYOFFICE Apps a um servidor RabbitMQ que já está em execução em outra máquina. Ignore a instalação do RabbitMQ com o parâmetro -irbt false e, em seguida, especifique os parâmetros de conexão do seu próprio servidor. Se você não especificar explicitamente o protocolo, o host, a porta ou o host virtual, os valores padrão serão usados.
Exemplo
bash apps-install.sh -irbt false --rabbitmqhost mq.example.com --rabbitmqusername username --rabbitmqpassword password
Isso instalará o ONLYOFFICE Apps sem o RabbitMQ e o conectará ao servidor RabbitMQ em execução no host mq.example.com.
Servidor Redis
| Parâmetro | Descrição | Padrão |
|---|---|---|
--redishost | host do servidor Redis | localhost |
--redisport | número da porta do servidor Redis | 6379 |
--redisusername | nome de usuário do Redis, se o servidor exigir autorização | - |
--redispassword | senha do usuário do Redis, se o servidor exigir autorização | - |
Use esses parâmetros para conectar o ONLYOFFICE Apps a um servidor Redis que já está em execução em outra máquina. Ignore a instalação do Redis com o parâmetro -irds false e, em seguida, especifique os parâmetros de conexão do seu próprio servidor. O nome de usuário e a senha só são necessários se o seu servidor Redis exigir autorização.
Exemplo
bash apps-install.sh -irds false --redishost redis.example.com --redispassword password
Isso instalará o ONLYOFFICE Apps sem o Redis e o conectará ao servidor Redis em execução no host redis.example.com.
Servidor OpenSearch
| Parâmetro | Descrição | Padrão |
|---|---|---|
--elasticprotocol | protocolo de conexão do OpenSearch | http |
--elasticport | número da porta do servidor OpenSearch | 9200 |
Use esses parâmetros junto com o parâmetro -esh, --elastichost descrito na seção Configuração para hosts acima para conectar o ONLYOFFICE Apps a um servidor OpenSearch em execução em outra máquina. Se você não especificar explicitamente o protocolo e a porta, os valores padrão serão usados.
Exemplo
bash apps-install.sh -esh search.example.com --elasticprotocol https --elasticport 9200
Isso conectará o ONLYOFFICE Apps ao servidor OpenSearch em execução no host search.example.com por HTTPS.
Alternando para HTTPS
| Parâmetro | Descrição |
|---|---|
-led, --letsencryptdomain | define o domínio para o certificado Let's Encrypt |
-lem, --letsencryptmail | define o endereço de e-mail do administrador do domínio para o certificado Let's Encrypt |
-cf, --certfile | caminho para o arquivo de certificado do domínio |
-ckf, --certkeyfile | caminho para o arquivo de chave privada do certificado |
Esses parâmetros permitem alternar o espaço de trabalho para HTTPS. Eles podem ser usados apenas na versão Docker.
Exemplo
bash apps-install.sh docker --letsencryptmail user@example.com --letsencryptdomain yourdomain.com
Isso criará e instalará automaticamente em seu servidor o certificado assinado pela CA letsencrypt.org e reiniciará o serviço NGINX para que as alterações entrem em vigor.
bash apps-install.sh docker --certfile path --certkeyfile path
Isso aplicará seu próprio certificado SSL.