diff --git a/readme.md b/readme.md index dff6513..6ad51c8 100644 --- a/readme.md +++ b/readme.md @@ -17,7 +17,7 @@ Antes de começar, certifique-se de ter os seguintes requisitos: - Docker e Docker Compose instalados ([Instruções](https://docs.docker.com/get-docker/)) - Uma conta Evolution API com chave válida - Uma conta GROQ API com chave válida (começa com 'gsk_') ([Crie sua CONTA](https://console.groq.com/login)) - +* Em caso de uso com Proxy Reverso Aponte um Subdomínio para a API e outro para o MANAGER da aplicação --- ## 🚀 **Instalação e Configuração** @@ -42,6 +42,8 @@ Antes de começar, certifique-se de ter os seguintes requisitos: - REDIS_HOST=redis - REDIS_PORT=6380 - API_DOMAIN=seu-ip + - DEBUG_MODE=false + - LOG_LEVEL=INFO - MANAGER_USER=admin - MANAGER_PASSWORD=sua_senha_aqui depends_on: @@ -125,7 +127,8 @@ uvicorn main:app --host 0.0.0.0 --port 8005 ```bash http://127.0.0.1:8005/transcreve-audios ``` - +1. Aponte um subomínio com o IP do seu servidor para a API da TranscreveZAP +2. Aponte um subomínio com o IP do seu servidor para o MANAGER da TranscreveZAP ### 🌟 Docker Swarm com Traefik ```yaml @@ -135,7 +138,7 @@ services: tcaudio: image: impacteai/transcrevezap:latest networks: - - transcrevezap_network + - sua_rede_externa # Substitua pelo nome da sua rede externa ports: - 8005:8005 # Porta para FastAPI - 8501:8501 # Porta para Streamlit @@ -144,13 +147,13 @@ services: - UVICORN_HOST=0.0.0.0 - UVICORN_RELOAD=true - UVICORN_WORKERS=1 - - API_DOMAIN=seu.dominio.com + - API_DOMAIN=seu.dominio.com #coloque seu subdominio da API apontado aqui - DEBUG_MODE=false - LOG_LEVEL=INFO - - MANAGER_USER=seu_usuario_admin - - MANAGER_PASSWORD=sua_senha_segura + - MANAGER_USER=seu_usuario_admin # Defina Usuário do Manager + - MANAGER_PASSWORD=sua_senha_segura # Defina Senha do Manager - REDIS_HOST=redis-transcrevezap - - REDIS_PORT=6380 + - REDIS_PORT=6380 # Porta personalizada para o Redis do TranscreveZAP depends_on: - redis-transcrevezap deploy: @@ -161,7 +164,7 @@ services: - node.role == manager labels: - traefik.enable=true - - traefik.http.routers.tcaudio.rule=Host(`seu.dominio.com`) + - traefik.http.routers.tcaudio.rule=Host(`seu.dominio.com`) #coloque seu subdominio da API apontado aqui - traefik.http.routers.tcaudio.entrypoints=websecure - traefik.http.routers.tcaudio.tls.certresolver=letsencryptresolver - traefik.http.services.tcaudio.loadbalancer.server.port=8005 @@ -170,7 +173,7 @@ services: - traefik.http.middlewares.traefik-compress.compress=true - traefik.http.routers.tcaudio.middlewares=traefik-compress # Configuração do Streamlit - - traefik.http.routers.tcaudio-manager.rule=Host(`manager.seu.dominio.com`) + - traefik.http.routers.tcaudio-manager.rule=Host(`manager.seu.dominio.com`) #coloque seu subdominio do Manager apontado aqui - traefik.http.routers.tcaudio-manager.entrypoints=websecure - traefik.http.routers.tcaudio-manager.tls.certresolver=letsencryptresolver - traefik.http.services.tcaudio-manager.loadbalancer.server.port=8501 @@ -183,10 +186,10 @@ services: volumes: - redis_transcrevezap_data:/data networks: - - transcrevezap_network + - sua_rede_externa # Substitua pelo nome da sua rede externa networks: - transcrevezap_network: + sua_rede_externa: # Substitua pelo nome da sua rede externa external: true name: sua_rede_externa # Substitua pelo nome da sua rede externa @@ -204,9 +207,10 @@ https://transcricaoaudio.seudominio.com.br/transcreve-audios Para usar com Traefik, certifique-se de: 1. Ter o Traefik configurado em seu ambiente Docker Swarm -2. Configurar o DNS do seu domínio para apontar para o servidor +2. Configurar 2 DNS do seu domínio para apontar para a API e para o MANAGER 3. Ajustar as labels do Traefik conforme seu ambiente 4. Verificar se a rede externa existe no Docker Swarm +5. Utilize a stack de exemplo contida no projeto para guiar a instalação ## 📝 **Notas Importantes** - A GROQ_API_KEY deve começar com 'gsk_'