Pular para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.kodus.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Como o Novita funciona

A Novita é uma plataforma de infraestrutura serverless para IA, projetada para escalar modelos open-source com baixa latência e custo reduzido. Suporta centenas de modelos prontos para produção — incluindo Llama, Mistral, Claude e Stable Diffusion — e fornece APIs otimizadas, GPUs sob demanda e implantações de modelos personalizados sem nenhuma sobrecarga de DevOps.

​
Modelos Recomendados

Recomendamos bons modelos de codificação com janela de contexto de +100k.
Para informações mais atualizadas, visite o site da Novita.
ModeloPreçoJanela de Contexto
Deepseek v3 0324 recomendado$0.33/1.3~128k tokens
Deepseek R1 0528$0.7/2.5~128k tokens
Llama 4 Maverick Instruct$0.17/0.85~100k tokens

​
Criando uma Chave de API

Uma conta Novita é necessária para criar uma Chave de API.
Acesse diretamente a página de Chaves de API da Novita para criar uma nova Chave de API. Ou siga estes passos:
  1. Vá para o seu console Novita
  2. Clique no botão “Gerenciar Chaves de API” ou vá para a sua foto de perfil e clique em Chaves de API
  3. Clique em “Adicionar Nova Chave” e preencha com ‘Kodus’ ou qualquer nome que desejar
  4. Clique em “Confirmar”
  5. Copie a Chave de API e guarde-a em um lugar seguro

​
System Requirements

  • Docker (latest stable) with the Compose plugin
  • Domain name or fixed IP if you want to receive Git webhooks from cloud providers (GitHub.com, GitLab.com, etc.)
Default host port mappings — adjust in .env if any conflict.
  • 3000 — Kodus Web App
  • 3001 — API
  • 3332 — Webhooks
  • 5432 — PostgreSQL
  • 27017 — MongoDB
  • 5672, 15672, 15692 — RabbitMQ (AMQP, management UI, metrics)
  • 3101 — MCP Manager (only if API_MCP_SERVER_ENABLED=true)
What ./scripts/install.sh brings up, based on your .env.Core (always on):
  • api — main backend
  • worker — code-review jobs
  • webhooks — Git provider webhook receiver
  • kodus-web — Next.js frontend
  • db_kodus_postgres, db_kodus_mongodb, rabbitmq — local infrastructure. Skip with USE_LOCAL_DB=false / USE_LOCAL_RABBITMQ=false to point at managed instances.
Optional:
  • kodus-mcp-manager — Model Context Protocol broker. Enable with API_MCP_SERVER_ENABLED=true. See MCP Manager.
  • worker-analytics — Cockpit ingestion (DORA metrics, PR classifier). Self-hosted Enterprise only, not wired by default. See Analytics Worker.
Code review uses an AST graph + cross-file context that runs in a sandbox — local (default, runs inside the worker) or e2b (paid remote sandbox). See Sandbox & AST Graph for the modes, caching behavior, and when to pick each.
Internet access is required if you plan to connect to cloud-based Git services (GitHub, GitLab, Bitbucket) or cloud LLM providers (OpenAI, Anthropic, etc.). For self-hosted Git tools and on-prem LLMs within your network, external internet access is optional.

​
Domain Name Setup (Optional)

If you're planning to integrate Kodus with cloud-based Git providers (GitHub, GitLab, or Bitbucket), you'll need public-facing URLs for both the Kodus Web App and its API. This allows your server to receive webhooks for proper Code Review functionality and ensures correct application behavior. We recommend setting up two subdomains:
  • One for the Web Application, e.g., kodus-web.yourdomain.com.
  • One for the API, e.g., kodus-api.yourdomain.com.
Webhooks are handled by a separate service (port 3332). You can either:
  • Use a dedicated webhooks subdomain, e.g., kodus-webhooks.yourdomain.com, or
  • Keep using the API domain and route /github/webhook, /gitlab/webhook, etc. to the webhooks service in your reverse proxy.
Both subdomains should have DNS A records pointing to your server's IP address. Later in this guide, we will configure a reverse proxy (Nginx) to route requests to these subdomains to the correct internal services. This setup is essential for full functionality, including webhooks and authentication.
Note: If you're only connecting to self-hosted Git tools on your network and do not require public access or webhooks, you might be able to use a simpler setup, but this guide focuses on public-facing deployments.

​
Setup

1

Clone the installer repository

git clone https://github.com/kodustech/kodus-installer.git
cd kodus-installer
2

Copy the example environment file

cp .env.example .env
3

Generate secure keys for the required environment variables

./generate-keys.sh
4

Edit the environment file

Edit .env with your values using your preferred text editor.
nano .env
See Environment Variables Configuration for detailed instructions.
5

Run the installer

./scripts/install.sh
6

Success 🎉

When complete, Kodus Services should be running on your machine. You can verify your installation using the following script:
./scripts/doctor.sh
7

Access the web interface

Once you access the web interface for the first time, you'll need to:
  1. Create your admin account - This will be the first user with full system access
  2. Configure your Git provider - Connect GitHub, GitLab, or Bitbucket following the on-screen instructions
  3. Select repositories for analysis - Choose which code repositories Kody will review
For detailed steps on the initial configuration process, refer to our Getting Started Guide.

​
Configurar a Novita no Arquivo de Ambiente

Edite o seu arquivo .env e configure as definições principais. Para a Integração de LLM, use a Novita no Modo Fixo: 
# Configurações Principais do Sistema (atualize com seus domínios)
WEB_HOSTNAME_API="kodus-api.yourdomain.com"    
WEB_PORT_API=443                               
NEXTAUTH_URL="https://kodus-web.yourdomain.com"

# Chaves de Segurança (gere com os comandos openssl acima)
WEB_NEXTAUTH_SECRET="your-generated-secret"
API_CRYPTO_KEY="your-generated-hex-key"
API_JWT_SECRET="your-generated-secret"
API_JWT_REFRESH_SECRET="your-generated-secret"

# Configuração do Banco de Dados
API_PG_DB_PASSWORD="your-secure-db-password"
API_MG_DB_PASSWORD="your-secure-db-password"

# Configuração Novita (Modo Fixo) 
API_LLM_PROVIDER_MODEL="deepseek-v3-0324"                    # Escolha seu modelo preferido
API_OPENAI_FORCE_BASE_URL="https://api.novita.ai/v3/openai"  # URL da API Novita
API_OPEN_AI_API_KEY="your-novita-api-key"                    # Sua Chave de API Novita

# Webhooks do Provedor Git (escolha seu provedor)
API_GITHUB_CODE_MANAGEMENT_WEBHOOK="https://kodus-api.yourdomain.com/github/webhook"
# ou API_GITLAB_CODE_MANAGEMENT_WEBHOOK="https://kodus-api.yourdomain.com/gitlab/webhook"
# ou GLOBAL_BITBUCKET_CODE_MANAGEMENT_WEBHOOK="https://kodus-api.yourdomain.com/bitbucket/webhook"
As URLs de webhook devem alcançar o serviço de Webhooks (porta 3332). Use um domínio dedicado para webhooks ou roteie /.../webhook para a porta 3332 no seu proxy reverso.
O Modo Fixo é ideal para a Novita porque ela fornece APIs compatíveis com OpenAI e requer apenas uma chave de API. Isso simplifica significativamente a sua configuração.

​
Run the Installation Script

Looking for more control? Check out our docker-compose file for manual deployment options.
Set the proper permissions for the installation script: 
chmod +x scripts/install.sh
Run the script: 
./scripts/install.sh

​
What the Installer Does

Our installer automates several important steps:
  • Verifies Docker installation
  • Creates networks for Kodus services
  • Clones repositories and configures environment files
  • Runs docker-compose to start all services
  • Executes database migrations
  • Seeds initial data
🎉 Success! When complete, the Kodus Web App and backend services (API, worker, webhooks, MCP manager) should be running on your machine. You can verify your installation by visiting http://localhost:3000 - you should see the Kodus Web Application interface.
Code Review features will not work yet unless you complete the reverse proxy setup. Without this configuration, external Git providers cannot send webhooks to your instance.

​
6. Configurar Proxy Reverso (Para Produção)

Para webhooks e acesso externo, configure o Nginx: 
# Aplicação Web (porta 3000)
server {
    listen 80;
    server_name kodus-web.yourdomain.com;
    location / {
        proxy_pass http://localhost:3000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

# API (porta 3001)  
server {
    listen 80;
    server_name kodus-api.yourdomain.com;
    location ~ ^/(github|gitlab|bitbucket|azure-repos)/webhook {
        proxy_pass http://localhost:3332;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }

    location / {
        proxy_pass http://localhost:3001;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
    }
}

​
Verificar a Integração com a Novita

Além da verificação básica de instalação, confirme que a Novita está funcionando: 
# Verificar especificamente a conexão com a API Novita
docker-compose logs api worker | grep -i novita
Para informações detalhadas sobre configuração de SSL, monitoramento e configurações avançadas, consulte nosso guia completo de implantação.

​
Solução de problemas

  • Verifique se sua chave de API está correta e ativa no console da Novita
  • Verifique se você tem créditos suficientes na sua conta Novita
  • Certifique-se de que não há espaços extras no seu arquivo .env
  • Verifique se o nome do modelo está escrito corretamente na sua configuração
  • Verifique se o modelo está disponível no seu plano Novita
  • Tente com um modelo diferente da nossa lista recomendada
  • Verifique se o seu servidor tem acesso à internet para alcançar api.novita.ai
  • Verifique se há restrições de firewall
  • Revise os logs da API/worker para mensagens de erro detalhadas