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)

Obtendo os arquivos de instalação e parametrizando

Neste tutorial passo a passo, você aprenderá o seguinte:

A partir da versão 03.008.000: configuração via .env

Nas versões 03.008.000 e superiores, a configuração que muda por instalação é centralizada em um único arquivo .env — você não edita mais o docker-compose.yml nem o alfresco-global.properties diretamente. Veja Configuração via arquivo .env e, para atualizar uma instalação existente, Migrando a configuração para o .env.

As seções abaixo continuam úteis como referência do significado de cada valor — na versão nova, cada um é definido pela variável correspondente do .env (ver a tabela De-Para na página de migração).

Obter arquivos de instalação​

Comece realizando o download da versão acessando o link disponibilizado pelo suporte HTF Apps para a sua versão contratada.

O conteúdo do arquivo contem:

  • Docker: (pasta com os arquivos necessários para funcionamento do sistema em ambiente Docker).
    • Completo: (pasta destinada para instalação completa do sistema com ECM Alfresco e as ferramentas HTF).
      • Arquivo docker-compose, script para inicialização, arquivos de parametrização.
    • Connector: (pasta destinada para instalação dos containers intermediários em caso de instalações com pontos de capturas fragmentados). Consulte o artigo Digitalização de documentos em pontos remotos.
      • Arquivo docker-compose e script para inicialização.
  • Capture-Print2ECM.exe: instalador para ambiente Windows do Presto Print2ECM (impressora virtual).
  • Capture-ScanLegacy.exe: instalador para ambiente Windows do Presto ScanLegacy (digitalização de legado).
  • Capture-SmartUX.apk: aplicativo de captura compatível com as multifuncionais da fabricante Samsung com suporte a plataforma SmartUX.
    • Capture-SmartUXServices.apk complemente necessário do aplicativo.
  • Capture-TwainConnector.exe: instalador para ambiente Windows do serviço para compatibilidade entre drivers Twain e o modulo de Captura. Consulte o artigo Digitalização de documentos com dispositivos Twain.
  • Capture-UWP Enable Multi-Users: registro a ser importado para estações de trabalho Windows que utilizarão o módulo de Captura compatível com Windows.
  • Capture-Xerox Registration.exe: executável manipulador de soluções EIP em dispositivos da fabricante XEROX.
    • Capture-Xerox Registration.xml: template com as predefinições para instalar o modulo Capture nos dispositivos.
  • HTF Root.cer e HTF Root.pem: certificados raiz a serem importados nas estações de trabalho e dispositivos quando se utilizar a auto assinatura do proxy. Consulte o artigo Auto assinatura do servidor proxy HTF Apps.
dica

Mova o conteúdo da pasta Docker/Completo para o servidor Linux para o diretório /home/docker

Parametrizando o docker-compose.yml​

Alguns parâmetros são necessários serem parametrizados para o funcionamento da ferramenta, ou seja obrigatórios.

Vamos começar inserindo a informação no serviço share:

  • PORT: defina qual a porta será utilizada para acessar a aplicação, por padrão é informada a porta 8080.
    • Caso altere este valor em WEB_PORT do serviço proxy, é necessário atualizar este parâmetro.

Já no serviço postgres vamos alterar:

  • POSTGRES_PASSWORD: a senha de autenticação para acessar o banco de dados, por padrão a senha é alfresco, recomenda-se alterar a mesma, caso o banco de dados seja publicado.
aviso

Alterar o valor da propriedade POSTGRES_PASSWORD após a primeira inicialização, ou seja, a criação do bando de dados propriamente dito, não afetará o banco de dados, e a senha do usurário.

No serviço licensing altere:

  • ADMIN_PASS: defina qual a senha parametrizada no Alfresco para o usuário admin, por padrão a senha do usuário é admin.
aviso

Ao alterar a senha do usuário admin, lembre-se que deve ser evitado caracteres especiais incompatíveis com o docker-compose.
Após a alteração é necessário parametrizar novamente a propriedade e reiniciar todos os serviços.

  • INSTALLATION_CODE: insira a chave de instalação obtiva no Back Office.

O serviço capture deve ser parametrizado:

  • LOGIN_REQUIRED: caso deseje que seja solicitado usuário e senha do Alfresco no painel dos pontos de captura, vamos definir como “on”, caso contrário como o padrão “off”.

O serviço captureconnector requer atenção, por isto, vamos parametrizar:

  • ALFRESCO_PROTOCOL: protocolo HTTP ou HTTPS utilizado na instalação, o padrão é http.
  • ALFRESCO_HOST: nome o host do container Alfresco ou url externa.
  • ALFRESCO_PORT: porta a qual se conectar ao container Alfresco
  • FTP_PORT: porta do sub serviço FTP, o padrão é 2121.
  • WSD_DEVICES: lista de urls separadas por virgula, dos dispositivos de captura que suportam o protocolo WSD .
  • TWAIN_CONNECTORS: lista de urls separadas por virgula, dos dispositivos que hospedem o serviço TwainConnector.

No serviço ftp, vamos parametrizar:

  • PASSIVE_ADDRESS: para correto funcionamento do ftp em modo passivo, é necessário inserir o IP externo da maquina host do sistema.

Por fim, no serviço proxy, vamos parametrizar:

  • SERVER_NAME: insira o nome do servidor proxy, normalmente se usa o domínio.
  • SERVER_EMAIL: insira o e-mail do servidor proxy.
  • DEFAULT_URL: insira a URL ao qual, será redirecionado ao acessar o sistema. Ex caso o usuário acesse http://alfersco.intranet:8080, ele será redirecionado a http://alfersco.intranet:8080/share.
  • PROTOCOL: insira qual protocolo irá usar, as opções são http e https. Para informações acesse Auto assinatura do servidor proxy HTF Apps.
  • WEB_PORT: insira a porta onde todos os serviços serão publicados a partir do proxy, o padrão é 8080.
  • AUTO_LETSENCRYPT: caso defina como “on” o proxy irá gerar um certificado e publicar os serviços utilizando um certificado auto assinado pela LetsEncrypt. (não recomendado, esta opção será descontinuada - os dispositivos atuais não reconhecem tais certificados como válidos, sendo acessíveis somente de terminais Windows, Linux e Mac).
  • AUTO_SELFSIGN: caso defina como “on” o proxy irá gerar um certificado e publicar os serviços utilizando um cerificado auto assinado por um certificado raiz HTF Apps, o mesmo não é uma certificadora válida, porém os certificados gerados pela ferramenta são demarcados como seguros nos aplicativos HTF Apps. Já em terminais Windows, Linux e Mac se faz necessário a instalação manual do certificado raiz como certificado confiável.
  • AUTO_SELFSIGN_HOSTS: caso habilite a opção AUTO_LETSENCRYPT ou AUTO_SELFSIGN, defina qual o nome fictício a ser usado como domínio, ex.: DNS:alfersco.intranet.
  • DNSMASK: O serviço proxy contempla um mini servidor DNS, capaz de redirecionar o domínio definido na opção anterior para o próprio proxy e consequentemente para as ferramentas. É indicado para instalações de pequeno e médio porte, em instalações de grande porte, recomenda-se utilizar a própria infraestrutura para gerenciamento de resolução de nomes. Não é possível utilizar caso o servidor seja publicado na internet.
  • DNSMASK_EXTERNALIP: definimos aqui, o IP externo da maquina host, ao qual será utilizado na tabela de resolução para o funcionamento do modulo DNS do container.
  • ports: vamos definir quais as portas serão publicadas na rede, é necessário atenção na parametrização para correto funcionamento. Definiremos dois pares de portas:
    • '8080:8080': ou o par de portas idênticas utilizadas para acesso a ferramenta, ou seja o valor definido em WEB_PORT.
    • 'IPEXTERNO:53:53/udp': caso utilize o modulo de DNS do container configure-o de acordo com o IP da maquina host.
      • Os dispositivos que irão acessar a ferramenta, devem ter como DNS primário em suas configurações o mesmo valor inerido em IPEXTERNO.
informação

Caso utilize um certificado assinado por uma certificadora CA válida - o recomendado, altere os arquivos /config/fullchain.pem e config/privkey.pem para os respectivos certificado em cadeia e a chave.

aviso

Alterar qualquer valor no docker-compose se faz necessário reiniciar os serviços.

Parametrização (arquivo .env)​

A partir da 03.008.000, esses valores são definidos no .env (veja o De-Para completo). Os principais:

  • DB_PASSWORD: senha do usuário do banco de dados (caso tenha alterado).
  • PUBLIC_BASE_URL: protocolo, host (IP externo ou domínio) e porta públicos do proxy — usado também para CMIS e AOS. Ex.: https://alfresco.intranet:8080.
  • HTF_TWOFA_ENABLED: habilita ou não a autenticação de dois fatores.
  • HTF_CAPTURE_PROCESSOR_RUNINSTANCES¹: número de instâncias de processamento simultâneas do CaptureProcessor.
  • HTF_CAPTURE_PROCESSOR_RUNIFWAITINGINSTANCES¹: instâncias simultâneas quando não há aplicação de tratamentos.
  • HTF_CAPTURE_WEB_MAX_FILES²: quantidade de arquivos anexáveis na Captura Web.
  • HTF_CAPTURE_WEB_MAX_FILESIZE²: tamanho máximo (MB) de cada arquivo na Captura Web.
  • HTF_CAPTURE_WEB_MAX_TOTAL_FILESSIZE²: tamanho total (MB) dos arquivos na Captura Web.
  • HTF_CAPTURE_PROCESSOR_JOINER_MAX²: tamanho máximo do arquivo de referência para o Joiner.
  • HTF_CAPTURE_PROCESSOR_HIGHPRIORITY_ENABLED³: prioridade no processamento de instâncias que referenciam um fluxo Process.
  • HTF_CAPTURE_PROCESSOR_EXTRAS_POSTISBUSY_ENABLED: anexa os arquivos ordenadamente (mantém a ordem da digitalização).
  • HTF_CAPTURE_PROCESSOR_JOINER_DONTMOVETOTRASH: apaga permanentemente (em vez de mover para a lixeira) os documentos anteriores ao Joiner.
  • SMS: o envio de SMS usa a conta própria do cliente (SMSDev ou PapoSMS), também no .env. Consulte SMS.

Permanecem no alfresco-global.properties as configurações nativas do Alfresco — por exemplo, LDAP, a restrição de usuários por site (htf.alfresco.restrictusergroupbysites) e overrides de CMIS/AOS, quando usados.

observação

¹ Tais valores impactam no consumo e requisitos de recursos computacionais.
² Não é recomendado alterar estes valores.
³ Instâncias prioritárias não são executadas simultaneamente com as não prioritárias — são escalonadas antes das demais.

Para parametrizar o servidor de envio de e-mails acesse: Parametrizando servidor de envio de e-mails..

Para sincronizar usuários do LDAP Active Directory acesse: Sincronizando Usuários LDAP-AD.

Caso queira expor o repositório via protocolo FTP acesse: Expondo o repositório via FTP.

Para informações sobre autenticação de dois fatores acesse: Habilitando autenticação de dois fatores.

Demais parametrizações referentes a integrações acesse: Integrações.

aviso

Alterar qualquer valor no alfresco-global.properties se faz necessário reiniciar os serviços.