Acesso à internet é necessário se você planeja conectar a serviços Git na nuvem (GitHub, GitLab, Bitbucket) ou provedores de LLM na nuvem (OpenAI, Anthropic, etc.). Para ferramentas Git auto-hospedadas e LLMs on-premise dentro da sua rede, o acesso externo à internet é opcional.
Se você planeja integrar o Kodus com provedores Git na nuvem (GitHub, GitLab ou Bitbucket), precisará de URLs públicas tanto para o Kodus Web App quanto para sua API. Isso permite que seu servidor receba webhooks para o correto funcionamento da Revisão de Código e garante o comportamento correto da aplicação.Recomendamos configurar dois subdomínios:
Um para o Aplicativo Web, ex.: kodus-web.seudominio.com.
Um para a API, ex.: kodus-api.seudominio.com.
Os webhooks são gerenciados por um serviço separado (porta 3332). Você pode:
Usar um subdomínio dedicado para webhooks, ex.: kodus-webhooks.seudominio.com, ou
Continuar usando o domínio da API e rotear /github/webhook, /gitlab/webhook, etc. para o serviço de webhooks no seu proxy reverso.
Ambos os subdomínios devem ter registros DNS A apontando para o endereço IP do seu servidor. Mais adiante neste guia, configuraremos um proxy reverso (Nginx) para rotear as requisições desses subdomínios para os serviços internos corretos. Esta configuração é essencial para a funcionalidade completa, incluindo webhooks e autenticação.
Nota: Se você estiver conectando apenas a ferramentas Git auto-hospedadas na sua rede e não precisar de acesso público ou webhooks, poderá usar uma configuração mais simples, mas este guia foca em implantações com acesso público.
Use esta seção para preencher seu .env. Comece pelas URLs públicas, depois configure
os bancos de dados e o RabbitMQ, e por fim adicione as configurações específicas dos provedores.
Estas configurações definem as URLs públicas e o binding de host utilizados pela aplicação web e pela API.
Se não estiver usando o MCP Manager, você pode ignorar as entradas MCP aqui e o
bloco completo abaixo.
WEB_HOSTNAME_API="kodus-api.yourdomain.com" # Hostname público da API (ex.: kodus-api.yourdomain.com)NEXTAUTH_URL="https://kodus-web.yourdomain.com" # URL base pública completa para a Aplicação Web (ex.: https://kodus-web.yourdomain.com)API_HOST=0.0.0.0 # Host da API (0.0.0.0 para desenvolvimento local)# Necessário apenas se quiser usar os recursos MCP.API_KODUS_SERVICE_MCP_MANAGER=http://kodus-mcp-manager:3101 # URL do MCP ManagerAPI_KODUS_MCP_SERVER_URL=http://kodus-api.yourdomain.com/mcp # URL do servidor MCP do Kodus
API_LLM_PROVIDER_MODEL="gpt-5" # Modelo que você deseja usarAPI_OPENAI_FORCE_BASE_URL="https://your-api.com/v1" # URL do seu provedor de APIAPI_OPEN_AI_API_KEY="your-api-key" # Chave de API do seu provedor
Consulte nossos guias específicos por modelo para instruções detalhadas de configuração com provedores populares como Novita, OpenAI, Anthropic e outros.
Use contêineres locais para Postgres e MongoDB por padrão. Atualize as credenciais
de acordo com seus requisitos de segurança.
# Use contêineres locais para Postgres e MongoDBUSE_LOCAL_DB=true# Configurações do PostgreSQLAPI_DATABASE_ENV="development" # development, production, testAPI_PG_DB_HOST=db_kodus_postgres # Host do PostgreSQLAPI_PG_DB_PORT=5432 # Porta do PostgreSQLAPI_PG_DB_USERNAME=kodusdev # Usuário do banco de dadosAPI_PG_DB_PASSWORD= # Senha do banco de dadosAPI_PG_DB_DATABASE=kodus_db # Nome do banco de dados# Configurações do MongoDBAPI_MG_DB_HOST=db_kodus_mongodb # Host do MongoDBAPI_MG_DB_PORT=27017 # Porta do MongoDBAPI_MG_DB_USERNAME=kodusdev # Usuário do banco de dadosAPI_MG_DB_PASSWORD= # Senha do banco de dadosAPI_MG_DB_DATABASE=kodus # Nome do banco de dadosAPI_MG_DB_PRODUCTION_CONFIG='' # Configurações adicionais de produção
O RabbitMQ é obrigatório na versão 2.0. Mantenha a URI sincronizada com os valores abaixo.
# Configuração do RabbitMQUSE_LOCAL_RABBITMQ=trueRABBITMQ_HOSTNAME=rabbitmq # Hostname do RabbitMQ na rede DockerRABBITMQ_DEFAULT_USER=kodus # Usuário do RabbitMQ (altere em produção)RABBITMQ_DEFAULT_PASS=kodus # Senha do RabbitMQ (altere em produção)# Mantenha a URI sincronizada com o usuário, senha e vhost acimaAPI_RABBITMQ_URI=amqp://kodus:kodus@rabbitmq:5672/kodus-ai # URI de conexão do RabbitMQAPI_RABBITMQ_ENABLED=true # RabbitMQ é obrigatório
Escolha e configure seu provedor Git preferido. Você pode configurar um ou mais
provedores; para autenticação básica por token, você só precisa da URL do webhook.
Os webhooks são tratados por um serviço separado (porta 3332). Suas URLs de webhook devem alcançar esse serviço. Você pode usar um domínio dedicado para webhooks, ou manter o domínio da API e rotear os caminhos /.../webhook para o serviço de webhooks no seu proxy reverso.
Usando OAuth do GitHub ou GitLab? Veja OAuth App do GitHub ou OAuth App do GitLab. Para configuração do GitHub App, veja GitHub App.
Github
GitLab
Bitbucket
Azure DevOps
# Necessário para autenticação baseada em tokenAPI_GITHUB_CODE_MANAGEMENT_WEBHOOK="https://kodus-api.yourdomain.com/github/webhook" # URL do webhook (use domínio de webhooks, ou domínio da API se roteado para o serviço de webhooks)
# Necessário para autenticação baseada em tokenAPI_GITLAB_CODE_MANAGEMENT_WEBHOOK="https://kodus-api.yourdomain.com/gitlab/webhook" # URL do webhook (use domínio de webhooks, ou domínio da API se roteado para o serviço de webhooks)
# Necessário para autenticação baseada em tokenGLOBAL_BITBUCKET_CODE_MANAGEMENT_WEBHOOK="https://kodus-api.yourdomain.com/bitbucket/webhook" # URL do webhook (use domínio de webhooks, ou domínio da API se roteado para o serviço de webhooks)
# Necessário para autenticação baseada em tokenGLOBAL_AZURE_REPOS_CODE_MANAGEMENT_WEBHOOK="https://kodus-api.yourdomain.com/azure-repos/webhook" # URL do webhook (use domínio de webhooks, ou domínio da API se roteado para o serviço de webhooks)
O MCP Manager é o serviço que conecta o Kody a ferramentas externas e as expõe
na tela de Plugins. Consulte nossa documentação do MCP Manager
para mais informações.
API_MCP_SERVER_ENABLED=false # Altere para true se quiser usar o MCP Manager---API_KODUS_SERVICE_MCP_MANAGER=http://kodus-mcp-manager:3101API_KODUS_MCP_SERVER_URL=http://localhost:3001/mcp# Configuração do MCP ManagerAPI_MCP_MANAGER_LOG_LEVEL=infoAPI_MCP_MANAGER_PORT=3101API_MCP_MANAGER_NODE_ENV=developmentAPI_MCP_MANAGER_DATABASE_ENV=developmentAPI_MCP_MANAGER_CORS_ORIGINS=*API_MCP_MANAGER_JWT_SECRET=API_MCP_MANAGER_COMPOSIO_BASE_URL=https://backend.composio.dev/api/v3API_MCP_MANAGER_COMPOSIO_API_KEY=API_MCP_MANAGER_MCP_PROVIDERS=kodusmcp,composio,customAPI_MCP_MANAGER_REDIRECT_URI=http://localhost:3000/setup/mcp/oauthAPI_MCP_MANAGER_PG_DB_SCHEMA=mcp-managerAPI_MCP_MANAGER_ENCRYPTION_SECRET=
Necessário apenas se quiser habilitar a revisão de código com AST.
O serviço AST analisa, recorta e manipula arquivos de código antes de chegarem ao pipeline de revisão. Isso melhora a qualidade da revisão e reduz o consumo de tokens. Ele está incluído no instalador e é executado como um contêiner separado.
API_ENABLE_CODE_REVIEW_AST=false # Defina como true para habilitar a revisão de código com ASTAPI_SERVICE_AST_URL= # URL interna do serviço AST
O serviço AST também possui seu próprio bloco de configuração. Esses valores são pré-configurados pelo instalador, mas podem ser ajustados para corresponder ao seu ambiente:
# KODUS_SERVICE_ASTNODE_ENV=developmentAPI_NODE_ENV=developmentAPI_LOG_PRETTY=trueAPI_LOG_LEVEL=infoCONTAINER_NAME=kodus-service-astAPI_PORT=3002# PostgreSQL — mantenha sincronizado com as configurações do banco de dados principalAPI_DATABASE_ENV="development"API_PG_DB_HOST=postgresAPI_PG_DB_PORT=5432API_PG_DB_USERNAME= # Mesmo que API_PG_DB_USERNAMEAPI_PG_DB_PASSWORD= # Mesmo que API_PG_DB_PASSWORDAPI_PG_DB_DATABASE=kodus_dbAPI_PG_DB_SCHEMA=kodus_workflow# RabbitMQ — mantenha sincronizado com as configurações do RabbitMQ principalRABBIT_URL= # ex.: amqp://user:pass@rabbitmq:5672/vhostRABBIT_RETRY_QUEUE=ast.jobs.retry.qRABBIT_RETRY_TTL_MS=60000RABBIT_PREFETCH=1RABBIT_PUBLISH_TIMEOUT_MS=5000RABBIT_SAC=false# LangChain (opcional — para rastreamento)LANGCHAIN_TRACING_V2=falseLANGCHAIN_API_KEY=LANGCHAIN_PROJECT=kodus-service-ast# Armazenamento compartilhadoSHARED_STORAGE_PATH=/shared# S3 (opcional)S3_ENABLED=falseS3_BUCKET_NAME=AWS_REGION=# Opções de build do grafoENABLE_INCREMENTAL_GRAPH=falseENABLE_GRAPH_BENCHMARK=falseENABLE_LIGHTWEIGHT_GRAPH=false
Estes serviços são opcionais, mas melhoram significativamente a qualidade da revisão de código do Kodus. Cada um requer a criação de uma conta e geração de uma chave de API.
E2B — Sandbox de Execução de Código
O E2B fornece um sandbox seguro que o Kodus usa para executar e validar código durante as revisões.
