Arquivo .env

Para executar a versão dockerizada da plataforma Navixy, o .env arquivo é o arquivo de configuração principal. Ele contém parâmetros importantes, como credenciais do banco de dados, nomes de domínio, pasta de trabalho da instalação da plataforma e outros.

O .env o arquivo é usado principalmente durante a instalação inicial da plataforma. No entanto, se precisar alterar algo na configuração de uma plataforma já existente, será necessário modificar este arquivo também.

Todos os parâmetros neste arquivo estão comentados para uma melhor compreensão do que você está lidando. Informações adicionais sobre esses parâmetros são descritas nas seções abaixo.

Se você alterar qualquer configuração enquanto a instância já estiver em execução, as alterações não são aplicadas instantaneamente. Você precisa reinicializar toda a instância para que entrem em vigor. Para fazer isso, a partir da pasta principal da plataforma (navixy-package), execute o comando: docker compose up -d Isto recriará os contêineres com as novas configurações.

UID e GID

Estes são parâmetros de serviço usados apenas na etapa de construção da plataforma. Não é necessário alterá-los.

WORKDIR

Este é um parâmetro que indica o diretório de trabalho da plataforma - onde o banco de dados e todos os arquivos de serviço são armazenados. É necessário proteger este diretório para evitar perda de dados comerciais.

Valor padrão deste parâmetro: WORKDIR=./work.

Isto significa que /work diretório dentro do build do Navixy descompactado é usado. Se o diretório não existir, ele será criado.

Se necessário, você pode colocar o diretório de trabalho em qualquer lugar do seu sistema. Para isso, especifique o caminho completo para o diretório. Exemplos:

  • /home/admin/work

  • /usr/local/navixy

Certifique-se de dar ao diretório um nome óbvio para não excluí‑lo por engano.

Este é o nome de usuário usado para acesso ao banco de dados. É sempre navixy, não o altere.

Esta é a senha para o usuário do banco de dados navixy . Por padrão, este valor está vazio e é necessário especificar a senha de sua escolha. Recomenda‑se gerar automaticamente uma senha forte, mas a escolha é sua, você pode especificar o que quiser.

Não altere esta senha após o banco de dados ser criado e a plataforma implantada.

service_domain

Este é o domínio principal da sua instância da plataforma. Ele é usado para:

  • Acesso à interface do usuário.

  • Ativação de dispositivos.

Caso esteja utilizando uma instalação com um único domínio (sem domínios separados para API e painel administrativo), este domínio também será usado para:

  • Acesso à API pelo link service_domain/api

  • Acesso ao painel administrativo pelo link service_domain/panel

Isto também pode ser um endereço IP do seu servidor se você não pretende usar nome de domínio para o seu serviço.

api_domain

Este parâmetro é opcional e é usado apenas para instalações com três domínios.

Aqui você deve especificar o nome de domínio usado para acessar a API da sua plataforma.

panel_domain

Este também é um parâmetro opcional usado para instalações com três domínios.

Aqui você deve especificar o nome de domínio usado para acessar o painel administrativo da sua plataforma.

le_enabled

Este parâmetro ativa a emissão automática e a reemissão subsequente do certificado SSL Let's Encrypt.

Está true por padrão. Isso significa que, quando você implantar a plataforma, o Certbot será configurado e cuidará da emissão automática do certificado SSL para seus domínios. Assim, você não precisará se preocupar em comprar certificados de terceiros. A instância será configurada para estar protegida por SSL.

Se desejar usar seu próprio certificado SSL em vez do Let's Encrypt, altere este parâmetro para false.

le_email

Este é o endereço de e‑mail para receber informações sobre a operação do Certbot, como expiração do certificado, revogação do certificado e problemas que possam impedir a reemissão do certificado.

Por padrão, este parâmetro está vazio. Recomenda‑se que especifique um endereço de e‑mail válido para não perder notificações importantes sobre a proteção SSL do seu site.

redirect_to_https

Esta configuração permite que requisições sejam redirecionadas de http para https. Se sua plataforma estiver configurada para usar proteção SSL e alguém tentar usar uma URL iniciando com http, um redirecionamento automático para https será acionado.

Se o parâmetro estiver desabilitado (false) então nenhum redirecionamento ocorrerá, e o site não será aberto.

Este parâmetro é aplicável apenas se a proteção SSL estiver habilitada e o certificado SSL estiver instalado.

service_ssl_cert and service_ssl_key

Se você não pretende usar o Let's Encrypt e deseja usar seu próprio certificado SSL em vez disso, precisa colocar o certificado do seu domínio e sua chave privada no diretório: WORKDIR/nginx/ssl.

Após o certificado e a chave estarem no lugar, é necessário especificar os nomes dos arquivos para os parâmetros correspondentes da configuração. Observe que não é necessário especificar caminhos. Exemplo:

service_ssl_cert=my_domain_com.crt
service_ssl_key=my_domain_com.key

MYSQL_RANDOM_ROOT_PASSWORD

Este parâmetro habilita a geração de senha aleatória para o MySQL root user. O valor padrão é true.

O parâmetro é usado apenas durante a inicialização inicial do banco de dados ao instalar a plataforma. Em reinicializações e atualizações posteriores da plataforma ele não faz nada, e a senha permanece a mesma.

Se preferir definir uma senha root específica para o MySQL, altere o valor para false e prossiga para o próximo parâmetro.

MYSQL_ROOT_PASSWORD

Aqui você especifica a senha root para o MySQL.

Este parâmetro é aplicado apenas quando MYSQL_RANDOM_ROOT_PASSWORD está alternado para false. Caso contrário, o valor é ignorado.

skip_db_update

Este parâmetro desabilita a atualização do banco de dados quando o contêiner navixy-standalone-db é iniciado. É usado para fins de teste, você não precisa alterar o valor padrão (false) durante o uso regular da plataforma.

Atualizado

Isto foi útil?