Em Desenvolvimento
Esta documentação ainda está em desenvolvimento. Agradecemos sua paciência!
Pular para o conteúdo principal
Versão: 03.008.000 🚧 (em desenvolvimento)

Configuração via arquivo .env

A partir da versão 03.008.000, a configuração que muda por instalação é centralizada em um único arquivo .env, na pasta do pacote de instalação. Esse .env é compartilhado pelos três componentes do ambiente — toolkit, Content App e Portal.

Em resumo

Você não edita mais o alfresco-global.properties nem espalha valores pelo docker-compose.yml. Você edita o .env.

Como funciona​

  • O .env é a fonte da verdade dos valores de configuração da instalação (banco, hosts, e-mail, chaves htf.*, tokens de integração, código de instalação, etc.).
  • Ao subir, o run.sh escreve os valores do .env no alfresco-global.properties (que vai versionado vazio, como modelo) e injeta as variáveis de ambiente nos containers.
  • O alfresco-global.properties versionado passa a conter apenas a infraestrutura interna fixa (driver do banco, nomes internos de serviço, mensageria, agendamentos) e as chaves que o Java lê, vazias — preenchidas a partir do .env.

Subindo o ambiente​

cp .env.example .env # primeira vez: copie o modelo
# edite o .env com os valores da sua instalação
./run.sh start # sobe o ambiente

Para conferir os valores aplicados ao alfresco-global.properties:

./run.sh sync

O comando sync é idempotente: se o valor já corresponde ao do .env, nada muda.

aviso

Após alterar qualquer valor no .env, é necessário subir novamente (ou reiniciar) os serviços para aplicar.

Cuidados ao preencher o .env​

  • Não envolva os valores em aspas. O valor é literal até o fim da linha. Caracteres como @, :, /, espaços e acentos não precisam de escape (ex.: MAIL_PASSWORD=ab@c123def).
  • Evite o caractere $ nas variáveis usadas pelo Docker Compose (como DB_PASSWORD, DB_USERNAME, DB_NAME, INSTALLATION_CODE, PORTAL_JWT_SECRET, PUBLIC_BASE_URL, SOLR_SHARED_SECRET, HOST_IP).
  • A DB_PASSWORD é usada na URL de conexão do Portal — evite os caracteres @ : / ? # nessa senha, pois quebram a URL.
  • Integrações que você não usa (token vazio): deixe a variável vazia no .env.

Chaves de configuração​

Além das chaves básicas (banco, hosts, e-mail, tokens de integração), o .env do pacote traz as chaves abaixo. Todas já vêm com um valor padrão adequado; altere apenas o que a sua instalação exigir.

Algoritmo de hash global​

ChavePadrãoDescrição
HTF_HASH_ALGORITHMsha-256Algoritmo de hash de todos os documentos da plataforma (por página, de conteúdo, base e do documento), com ou sem guarda documental. Valores: md2, md5, sha-1, sha-256, sha-384, sha-512.
HTF_HASH_RESPECTEXISTINGtrueCom true, o documento que já tem um algoritmo gravado mantém o dele (um acervo legado em MD5 continua em MD5 e reprodutível); só documentos novos usam o algoritmo global. Com false, todo recálculo passa a usar o algoritmo global, alterando os hashes dos documentos legados no próximo reprocessamento.

O algoritmo não é escolhido por documento, perfil, ação ou execução de preservação: a escolha é única, feita aqui. O hash é gerado em todo documento capturado, e o campo de tipo de hash no cartão de metadados é somente leitura.

Segurança, senhas e interface​

ChavePadrãoDescrição
HTF_TWOFA_ENABLED / HTF_TWOFA_FORCEfalseHabilita o 2FA e, opcionalmente, o torna obrigatório.
HTF_TOTP_ISSUER / HTF_TOTP_PERIODHTF Apps Toolkit / 30Nome exibido no aplicativo autenticador e período do código, em segundos.
HTF_PASSWORD_MIN_LENGTHconforme o pacoteComprimento mínimo de senha, aplicado a todas as telas de definição e troca de senha.
HTF_DEFAULT_FRONTENDshareInterface padrão do usuário (share ou aca).
HTF_RESTRICT_USERGROUP_BY_SITESconforme o pacoteRestringe a listagem de usuários e grupos aos sites do usuário.
CA_REFRESH_ON_BOOTfalseAtualiza o conjunto de CAs de confiança a cada inicialização. Veja Parametrizando certificado SSL.

Operação e guarda​

ChavePadrãoDescrição
HTF_PRESERVATION_DISABLEBOOTfalseUso em emergência: com true, desliga na inicialização a retomada da Preservação e o supervisor da preservação diária (evita ciclos de falta de memória quando uma execução travou por um arquivo muito grande). Execuções manuais continuam possíveis.
HTF_CUSTODY_VERSIONCLEANENABLEDfalsePolítica da instalação para limpar o histórico de versões. Com false, ninguém pode limpar versões.
HTF_SEARCH_ACCELERATEDtrueBusca acelerada de tarefas e fluxos (ver notas de upgrade das Notas de Lançamento).
HTF_SEARCH_MINWORDLEN5Tamanho mínimo, em caracteres, das palavras indexadas na busca acelerada (mínimo efetivo 5; números com 4 ou mais dígitos, como CPF e telefone, entram sempre). Alterar o valor refaz o índice na próxima inicialização, com a mesma janela de indisponibilidade do /process. Só vale com a busca acelerada ligada.

Captura​

ChaveDescrição
HTF_CAPTURE_PROCESSOR_RUNINSTANCES / HTF_CAPTURE_PROCESSOR_RUNIFWAITINGINSTANCESQuantidade de instâncias de captura simultâneas e quantas rodam quando há instâncias aguardando.
HTF_CAPTURE_PROCESSOR_JOINER_MAXMáximo de arquivos consolidados por documento.
HTF_CAPTURE_WEB_MAX_FILES / HTF_CAPTURE_WEB_MAX_FILESIZE / HTF_CAPTURE_WEB_MAX_TOTAL_FILESSIZELimites de envio pelo Capture Web: quantidade de arquivos, tamanho por arquivo e tamanho total (MB).
LOGIN_REQUIREDon exige login no Capture Web; off permite acesso anônimo.
WSD_DEVICES / TWAIN_CONNECTORSDispositivos de captura de rede (conector). Vazio, nenhum.

Backup Agent​

ChaveDescrição
RESTIC_PASSWORDSenha do backup incremental. Vazia, o Backup Agent gera uma automaticamente. Defina para fixá-la e torná-la reproduzível; não a troque depois do primeiro backup incremental. Evite o caractere $. Veja Backup Agent.

Chaves de IA e assinatura​

HTF_GEMINI_KEYS e HTF_GEMINI_MAX_CONCURRENT_TASKS são descritas em IA Gemini, com o passo a passo para criar a chave da API. As chaves de TSA, SafeID, DocuSign, Certisign, Selbetti e SMS têm página própria na seção Integrações.

Pré-requisito de imagem

Esta versão lê várias chaves htf.* a partir do ambiente. Use as imagens prestobr/toolkit-* desta versão em diante. Uma imagem de versão anterior combinada com o modelo novo faria essas chaves virem vazias.