|
|
| (12 revisões intermediárias pelo mesmo usuário não estão sendo mostradas) |
| Linha 1: |
Linha 1: |
| == Tutorial de Configuração da Evolution API para WhatsApp no Celta ==
| | {{Cabecalho |
| Este tutorial orienta a instalação e configuração do ambiente WSL, Docker e Evolution API no Windows para integração com o Celta. O objetivo é automatizar a instalação e garantir que a API do WhatsApp esteja funcional.
| | | [[Documentação]] |
| | | Configuração do WhatsApp (Evolution API) |
| | }} |
|
| |
|
| === Requisitos ===
| | Este guia orienta a instalação e configuração da '''Evolution API''' utilizando a integração nativa com o '''Docker Desktop'''. |
| * '''Sistema Operacional''': Windows 10 ou superior (versões anteriores não são compatíveis com WSL 2).
| |
| * '''Virtualização''': Habilitada na BIOS/UEFI (veja como verificar abaixo).
| |
| * '''Privilégios''': Script deve ser executado como administrador.
| |
|
| |
|
| === Passo a Passo ===
| | O Sistema Celta automatiza 90% do processo, baixando a imagem oficial, criando os arquivos de configuração (`docker-compose.yaml`) e gerenciando o serviço. |
|
| |
|
| ==== 1. Verificar Requisitos do Sistema ====
| | == 1. Pré-requisitos do Ambiente == |
| # '''Confirme a versão do Windows''':
| |
| ## Abra o menu Iniciar, digite <code>winver</code> e pressione Enter.
| |
| ## Verifique se a versão é 10 ou superior (ex.: "Versão 22H2"). Caso contrário, atualize o sistema.
| |
|
| |
|
| ==== 2. Verificar Virtualização na BIOS ====
| | Antes de iniciar, garanta que o servidor atenda aos requisitos mínimos para virtualização. |
| # '''Checar se está habilitada''':
| |
| ## Abra o Gerenciador de Tarefas (Ctrl + Shift + Esc).
| |
| ## Vá para a aba "Desempenho" e procure por "Virtualização" na seção da CPU.
| |
| ## Se estiver "Habilitado", prossiga. Se "Desabilitado", siga os passos abaixo.
| |
| # '''Habilitar virtualização na BIOS''':
| |
| ## Reinicie o computador e entre na BIOS/UEFI (teclas comuns: F2, Del, F10 - consulte o manual da placa-mãe).
| |
| ## Procure por opções como "Intel VT-x", "AMD-V" ou "Virtualization Technology" (geralmente em "Advanced" ou "CPU Configuration").
| |
| ## Habilite a opção e salve as alterações (F10 para salvar e sair na maioria dos casos).
| |
| ## Reinicie o sistema e confirme no Gerenciador de Tarefas que a virtualização está ativa.
| |
|
| |
|
| ==== 3. Gerar Arquivos no Sistema Celta ====
| | {{Nota|warning|REQUISITO DE BIOS / UEFI|Para o funcionamento do Docker, a '''Virtualização''' deve estar habilitada na BIOS do computador. |
| # Abra o Celta no computador que será o servidor.
| | * '''Verificação:''' Abra o Gerenciador de Tarefas (Ctrl+Shift+Esc) > Aba Desempenho > CPU. |
| # Navegue até:
| | * Procure por "Virtualização: '''Habilitado'''". |
| ## '''Principal > WhatsApp > Configurações > Gerar Arquivos'''.
| | * Se estiver "Desabilitado", é necessário reiniciar o PC e ativar na BIOS (Intel VT-x ou AMD-V).}} |
| # Clique em "Gerar Arquivos" para criar:
| |
| ## <code>docker-compose.yaml</code>
| |
| ## <code>.env</code>
| |
| # Esses arquivos serão salvos em <code>C:\Celta Sistemas\WhatsApp</code> com o IP fixo da máquina atual. Confirme que o IP no arquivo <code>.env</code> corresponde ao IP fixo do computador servidor (use <code>ipconfig</code> no Prompt de Comando para verificar).
| |
|
| |
|
| ==== 4. Verificar Arquivos Obrigatórios ==== | | === Requisitos de Hardware/Software === |
| # Navegue até <code>C:\Celta Sistemas\WhatsApp</code> no Explorador de Arquivos.
| | * '''Sistema Operacional:''' Windows 10 (21H2+) ou Windows 11. |
| # Confirme a presença dos arquivos:
| | * '''Memória RAM:''' Mínimo 8GB (Recomendado 16GB). |
| ## <code>Install.ps1</code> (script PowerShell) [https://www.dropbox.com/scl/fi/sgh1knqy1ive6b7mxd2gh/Install.ps1?rlkey=f0mowjuhhv4h03bnmd11mvw0t&st=6zyfh7ob&dl=0 Download]
| | * '''WSL 2:''' O Docker Desktop utiliza o subsistema Linux do Windows. O instalador do Docker geralmente ativa isso automaticamente. |
| ## <code>setup_docker_api.sh</code> (script Bash) [https://www.dropbox.com/scl/fi/klwmqxa6z1tlnf2xe44nj/setup_docker_api.sh?rlkey=2q27ocm7p0cgcrtz506xkq0kj&st=x0brk8vq&dl=0 Download]
| |
| ## <code>.env</code> (gerado pelo Celta)
| |
| ## <code>docker-compose.yaml</code> (gerado pelo Celta)
| |
| # Se algum arquivo estiver ausente, repita o passo 3 ou contate a equipe técnica.
| |
|
| |
|
| == Tutorial de Configuração da Evolution API para WhatsApp no Celta == | | == 2. Instalação Automática == |
| Este tutorial orienta a instalação e configuração da Evolution API no Windows para integração com o Celta, oferecendo duas opções: via WSL (Ubuntu) ou Docker Desktop. O objetivo é automatizar a instalação e garantir que a API do WhatsApp esteja funcional.
| |
|
| |
|
| === Requisitos Comuns ===
| | O Celta possui um "Wizard" que configura o ambiente sem necessidade de comandos manuais. |
| * '''Sistema Operacional''': Windows 10 ou superior (versões anteriores não são compatíveis com WSL 2 ou Docker Desktop).
| |
| * '''Virtualização''': Habilitada na BIOS/UEFI (veja como verificar abaixo).
| |
| * '''Privilégios''': O Celta e os scripts devem ser executados como administrador.
| |
|
| |
|
| === Verificar Requisitos do Sistema ===
| | # Execute o Celta como '''Administrador'''. |
| # '''Confirme a versão do Windows''': | | # Acesse '''Principal > WhatsApp > Configurações'''. |
| ## Abra o menu Iniciar, digite <code>winver</code> e pressione Enter. | | # Na aba '''Configuração''': |
| ## Verifique se a versão é 10 ou superior (ex.: "Versão 22H2"). Caso contrário, atualize o sistema. | | #* '''Host:''' Informe o IP fixo ou Nome do Computador Servidor (Ex: `192.168.1.200`). |
| | #* '''Modo:''' Selecione a opção '''Usar Docker Desktop'''. |
| | # Clique em '''Iniciar Instalação'''. |
|
| |
|
| === Verificar Virtualização na BIOS ===
| | {{Nota|info|BASTIDORES (O que o Celta faz?)| |
| # '''Checar se está habilitada''':
| | Ao clicar em instalar, o sistema executa em segundo plano: |
| ## Abra o Gerenciador de Tarefas (Ctrl + Shift + Esc).
| | # Cria a pasta `C:\Celta Sistemas\WhatsApp`. |
| ## Vá para a aba "Desempenho" e procure por "Virtualização" na seção da CPU.
| | # Gera o arquivo `docker-compose.yaml` configurado com o Host informado. |
| ## Se estiver "Habilitado", prossiga. Se "Desabilitado", siga os passos abaixo.
| | # Verifica se o Docker Desktop está instalado (inicia o download se não estiver). |
| # '''Habilitar virtualização na BIOS''': | | # Sobe o container da Evolution API na porta '''8010'''. |
| ## Reinicie o computador e entre na BIOS/UEFI (teclas comuns: F2, Del, F10 - consulte o manual da placa-mãe). | | }} |
| ## Procure por opções como "Intel VT-x", "AMD-V" ou "Virtualization Technology" (geralmente em "Advanced" ou "CPU Configuration"). | |
| ## Habilite a opção e salve as alterações (F10 para salvar e sair na maioria dos casos). | |
| ## Reinicie o sistema e confirme no Gerenciador de Tarefas que a virtualização está ativa.
| |
|
| |
|
| == Configuração via WSL (Ubuntu) == | | === Validação === |
| Esta seção descreve a instalação da Evolution API usando WSL e Ubuntu.
| | Aguarde o log na tela exibir: *"Ambiente Docker configurado com sucesso"*. |
| | Após isso, o status mudará para '''Aguardando escaneamento''' (QR Code). |
|
| |
|
| === Passo a Passo === | | == 3. Configuração de Inicialização == |
|
| |
|
| ==== 1. Gerar Arquivos no Sistema Celta ====
| | Para garantir que a API suba automaticamente após uma queda de energia ou reinicialização do servidor: |
| # Abra o Celta no computador que será o servidor.
| |
| # Navegue até:
| |
| ## '''Principal > WhatsApp > Configurações > Gerar Arquivos'''.
| |
| # Clique em "Gerar Arquivos" para criar:
| |
| ## <code>docker-compose.yaml</code>
| |
| ## <code>.env</code>
| |
| # Esses arquivos serão salvos em <code>C:\Celta Sistemas\WhatsApp</code> com o IP fixo da máquina atual. Confirme que o IP no arquivo <code>.env</code> corresponde ao IP fixo do computador servidor (use <code>ipconfig</code> no Prompt de Comando para verificar).
| |
|
| |
|
| ==== 2. Verificar Arquivos Obrigatórios ====
| | # Abra o '''Docker Desktop'''. |
| # Navegue até <code>C:\Celta Sistemas\WhatsApp</code> no Explorador de Arquivos. | | # Clique no ícone de engrenagem ('''Settings''') > '''General'''. |
| # Confirme a presença dos arquivos: | | # Marque a opção: <i class="bi bi-check-square-fill" style="color:#0d6efd;"></i> '''Start Docker Desktop when you sign in'''. |
| ## <code>Install.ps1</code> (script PowerShell) [https://www.dropbox.com/scl/fi/sgh1knqy1ive6b7mxd2gh/Install.ps1?rlkey=f0mowjuhhv4h03bnmd11mvw0t&st=6zyfh7ob&dl=0 Download]
| |
| ## <code>setup_docker_api.sh</code> (script Bash) [https://www.dropbox.com/scl/fi/klwmqxa6z1tlnf2xe44nj/setup_docker_api.sh?rlkey=2q27ocm7p0cgcrtz506xkq0kj&st=x0brk8vq&dl=0 Download]
| |
| ## <code>.env</code> (gerado pelo Celta)
| |
| ## <code>docker-compose.yaml</code> (gerado pelo Celta) | |
| # Se algum arquivo estiver ausente, repita o passo 1 ou contate a equipe técnica.
| |
|
| |
|
| ==== 3. Executar o Script PowerShell ==== | | == 4. Gerenciamento de Sessões == |
| # Clique com o botão direito no PowerShell, selecione '''Executar como administrador'''.
| |
| # Habilite a execução de scripts no PowerShell com o comando:
| |
| ## <code>Set-ExecutionPolicy -Scope CurrentUser -ExecutionPolicy Unrestricted</code>
| |
| # Navegue até o diretório do script (<code>cd C:\Celta Sistemas\WhatsApp</code>).
| |
| # Execute o script com:
| |
| ## <code>.\Install.ps1</code>
| |
| # O script irá:
| |
| ## Habilitar Hyper-V e Plataforma da Máquina Virtual (pode exigir reinicialização).
| |
| ## Instalar o WSL e o Ubuntu-24.04.
| |
| ## Configurar o usuário "celta" no Ubuntu.
| |
| ## Instalar e configurar o Docker e a Evolution API.
| |
| ## Criar regras de firewall e tarefas agendadas.
| |
|
| |
|
| ==== 4. Executar o Script Bash no WSL ====
| | O Celta permite gerenciar múltiplas conexões (multitenancy) na aba '''Gerenciar'''. |
| # Após o script PowerShell instalar o WSL e Ubuntu, o script Bash (<code>setup_docker_api.sh</code>) será executado automaticamente.
| |
| # Ele irá:
| |
| ## Atualizar pacotes no Ubuntu.
| |
| ## Instalar o Docker e Docker Compose.
| |
| ## Configurar o serviço da Evolution API para iniciar automaticamente.
| |
|
| |
|
| ==== 5. Verificação Final ==== | | {{TabelaCampos| |
| # Verifique se a API está rodando:
| | {{Linha |
| ## Abra um navegador e acesse <code>http://localhost:8010</code>.
| | | 1= Listar Instâncias |
| ## Se a página da Evolution API carregar, a configuração foi bem-sucedida.
| | | 2= Clique em "Listar" para ver todas as sessões ativas no Docker. |
| # Caso contrário, consulte as notas de erros abaixo.
| | * Mostra: Nome, Número, Status e Data de Criação. |
| | }} |
| | {{Linha |
| | | 1= Desconectar / Excluir |
| | | 2= Clique com o botão direito sobre uma instância na lista para: |
| | * '''Desconectar:''' Encerra a sessão do WhatsApp Web. |
| | * '''Deletar:''' Remove completamente a instância da API (útil para limpar cache ou erros de conexão). |
| | }} |
| | }} |
|
| |
|
| === Notas === | | == 5. Diagnóstico e Solução de Problemas == |
| * '''Erros Comuns''':
| |
| ** '''"Arquivos .env ou docker-compose.yaml não encontrados"''': Certifique-se de gerar os arquivos no Celta (passo 1).
| |
| ** '''"Falha ao habilitar Hyper-V ou WSL"''': Confirme que a virtualização está ativa na BIOS e que o Windows está atualizado.
| |
| ** '''"Serviço evolution-api.service não ativo"''': Verifique os logs (veja abaixo).
| |
| * '''Onde Encontrar Logs''':
| |
| ** PowerShell: <code>%TEMP%\wsl_docker_setup_DDMMYYYY_HHMMSS.log</code> (ex.: <code>C:\Users\SeuUsuario\AppData\Local\Temp</code>).
| |
| ** Evolution API: No WSL, execute <code>cat /var/log/evolution-api.log</code>.
| |
| ** Status do serviço: No WSL, execute <code>sudo systemctl status evolution-api.service</code>.
| |
| * '''Ativar Debug no WSL''':
| |
| ## No Windows, crie ou edite o arquivo <code>.wslconfig</code> em <code>C:\Users\SeuUsuario\.wslconfig</code> (substitua "SeuUsuario" pelo nome do seu usuário).
| |
| ## Adicione as linhas:
| |
| ## <code>debugConsole=true</code>
| |
| ## Salve o arquivo e reinicie o WSL com <code>wsl --shutdown</code> no PowerShell ou Prompt de Comando.
| |
| ## Os logs de depuração do WSL serão exibidos no console. Capture-os e envie para a equipe técnica, junto com os logs da Evolution API em <code>/var/log/evolution-api.log</code> (acessível via WSL com <code>cat /var/log/evolution-api.log</code>).
| |
|
| |
|
| === Resultado Esperado ===
| | Se houver erros no Log ou o QR Code não aparecer, consulte a tabela abaixo. |
| Após seguir os passos, a Evolution API estará rodando na porta 8010 e integrada ao Celta para uso do WhatsApp. O serviço iniciará automaticamente ao ligar o computador.
| |
|
| |
|
| == Configuração via Docker Desktop == | | {{TabelaCampos| |
| Esta seção descreve a instalação simplificada da Evolution API usando o Docker Desktop, totalmente gerenciada pelo Celta.
| | {{Linha |
| | | 1= Erro: "Docker não instalado" |
| | | 2= O download automático falhou ou foi bloqueado. |
| | * '''Solução:''' Baixe e instale o [https://www.docker.com/products/docker-desktop/ Docker Desktop] manualmente e depois clique em "Iniciar Instalação" no Celta novamente. |
| | }} |
| | {{Linha |
| | | 1= Erro: "Porta 8010 ocupada" |
| | | 2= Outro serviço está usando a porta da API. |
| | * '''Solução:''' Verifique conflitos ou altere a porta no arquivo `.env` dentro da pasta do WhatsApp e reinicie o container. |
| | }} |
| | {{Linha |
| | | 1= Erro: "WSL error / Hyper-V" |
| | | 2= O Windows não conseguiu iniciar o motor de virtualização. |
| | * '''Solução:''' Confirme se a Virtualização está ativa na BIOS e se o recurso "Plataforma de Máquina Virtual" está marcado nos Recursos do Windows. |
| | }} |
| | }} |
|
| |
|
| === Passo a Passo ===
| | {{ContatoSuporte}} |
| | |
| ==== 1. Gerar Arquivos no Sistema Celta ====
| |
| # Abra o Celta com permissões de administrador.
| |
| # Navegue até:
| |
| ## '''Principal > WhatsApp > Configurações > Gerar Arquivos'''.
| |
| # Clique em "Gerar Arquivos" para criar:
| |
| ## <code>docker-compose.yaml</code>
| |
| ## <code>.env</code>
| |
| # Os arquivos serão salvos em <code>C:\Celta Sistemas\WhatsApp</code> com o IP fixo da máquina (confirme com <code>ipconfig</code>).
| |
| | |
| ==== 2. Executar a Configuração no Celta ====
| |
| # Na mesma tela, clique em "Inicializar API".
| |
| # O Celta configura tudo automaticamente e exibe o progresso no log:
| |
| ## Cria o diretório <code>C:\Celta Sistemas\WhatsApp</code>.
| |
| ## Gera os arquivos Docker com o IP informado.
| |
| ## Verifica o Hyper-V e orienta a ativação, se necessário.
| |
| ## Libera a porta 8010 no firewall.
| |
| ## Instala o Docker Desktop (inicia o download se ausente).
| |
| ## Inicia o Docker e sobe os containers da Evolution API.
| |
| # Se concluído, o log mostra:
| |
| ## "Ambiente Docker configurado com sucesso".
| |
| | |
| ==== 3. Verificação Final ====
| |
| # Clique em "Testar API" no Celta ou acesse <code>http://localhost:8010</code> no navegador.
| |
| # Se a página da Evolution API carregar, a configuração está pronta.
| |
| | |
| === Notas ===
| |
| * '''Erros Comuns''':
| |
| ** '''"Docker não instalado"''': Instale manualmente após o download iniciado pelo Celta.
| |
| ** '''"Porta 8010 ocupada"''': Feche outros aplicativos ou libere a porta.
| |
| ** '''"Hyper-V desabilitado"''': Ative em "Recursos do Windows".
| |
| * '''Logs''':
| |
| ** Veja o memo no Celta ou os containers no Docker Desktop.
| |
| | |
| === Resultado Esperado ===
| |
| A
| |
| | |
| ==== 6. Executar o Script Bash no WSL ====
| |
| # Após o script PowerShell instalar o WSL e Ubuntu, o script Bash (<code>setup_docker_api.sh</code>) será executado automaticamente.
| |
| # Ele irá:
| |
| ## Atualizar pacotes no Ubuntu.
| |
| ## Instalar o Docker e Docker Compose.
| |
| ## Configurar o serviço da Evolution API para iniciar automaticamente.
| |
| | |
| ==== 7. Verificação Final ====
| |
| # Verifique se a API está rodando:
| |
| ## Abra um navegador e acesse <code>http://localhost:8010</code>.
| |
| ## Se a página da Evolution API carregar, a configuração foi bem-sucedida.
| |
| # Caso contrário, consulte as notas de erros abaixo.
| |
| | |
| === Notas ===
| |
| * '''Erros Comuns''':
| |
| ** '''"Arquivos .env ou docker-compose.yaml não encontrados"''': Certifique-se de gerar os arquivos no Celta (passo 3).
| |
| ** '''"Falha ao habilitar Hyper-V ou WSL"''': Confirme que a virtualização está ativa na BIOS e que o Windows está atualizado.
| |
| ** '''"Serviço evolution-api.service não ativo"''': Verifique os logs (veja abaixo).
| |
| * '''Onde Encontrar Logs''':
| |
| ** PowerShell: <code>%TEMP%\wsl_docker_setup_DDMMYYYY_HHMMSS.log</code> (ex.: <code>C:\Users\SeuUsuario\AppData\Local\Temp</code>).
| |
| ** Evolution API: No WSL, execute <code>cat /var/log/evolution-api.log</code>.
| |
| ** Status do serviço: No WSL, execute <code>sudo systemctl status evolution-api.service</code>.
| |
| * '''Ativar Debug no WSL''':
| |
| ## No Windows, crie ou edite o arquivo <code>.wslconfig</code> em <code>C:\Users\SeuUsuario\.wslconfig</code> (substitua "SeuUsuario" pelo nome do seu usuário).
| |
| ## Adicione as linhas:
| |
| ## <code>debugConsole=true</code>
| |
| ## Salve o arquivo e reinicie o WSL com <code>wsl --shutdown</code> no PowerShell ou Prompt de Comando.
| |
| ## Os logs de depuração do WSL serão exibidos no console. Capture-os e envie para a equipe técnica, junto com os logs da Evolution API em <code>/var/log/evolution-api.log</code> (acessível via WSL com <code>cat /var/log/evolution-api.log</code>).
| |
| | |
| === Resultado Esperado ===
| |
| Após seguir os passos, a Evolution API estará rodando na porta 8010 e integrada ao Celta para uso do WhatsApp. O serviço iniciará automaticamente ao ligar o computador.
| |
