Pular para o conteúdo principal

​
Como o Groq funciona

O Groq Cloud fornece inferência rápida de LLM com APIs compatíveis com OpenAI. Desenvolvido para velocidade e simplicidade, o Groq oferece inferência ultrarrápida para modelos populares como Llama, Deepseek e mais. A plataforma é projetada para ser simples de integrar e fácil de escalar, tornando-a perfeita para aplicações em produção.

​
Modelos Recomendados

Recomendamos bons modelos de codificação com janelas de contexto grandes e inferência rápida.
Para as informações mais atualizadas, visite a página de modelos do Groq.
ModeloJanela de ContextoVelocidade
Llama 3.3 70B Versatile recomendado~128k tokensUltra Rápida
Deepseek R1 Distill Llama 70B~128k tokensUltra Rápida
Llama 3.1 70B Versatile~128k tokensUltra Rápida

​
Criando uma Chave de API

Uma conta Groq Cloud é necessária para criar uma Chave de API.
Acesse diretamente a página de Chaves de API do Groq para criar uma nova Chave de API. Ou siga estes passos:
  1. Vá para o Console Groq
  2. Faça login ou crie sua conta
  3. Navegue até “Chaves de API” na navegação superior
  4. Clique no botão “Criar Chave de API”
  5. Dê um nome como ‘Kodus’ ou qualquer nome descritivo
  6. Copie a Chave de API e guarde-a em um lugar seguro
Apenas proprietários de time ou usuários com papel de desenvolvedor podem criar ou gerenciar chaves de API no Groq.

​
Como usar

​
System Requirements

  • Docker (latest stable version)
  • Node.js (latest LTS version)
  • Yarn or NPM (latest stable version)
  • Domain name or fixed IP (for external deployments)
  • 3000: Kodus Web App
  • 3001: API
  • 3332: Webhooks
  • 5672, 15672, 15692: RabbitMQ (AMQP, management, metrics)
  • 3101: MCP Manager (API, metrics)
  • 5432: PostgreSQL - 27017: MongoDB
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 o Groq no Arquivo de Ambiente

Edite o seu arquivo .env e configure as definições principais. Para a Integração de LLM, use o Groq 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"
WEB_JWT_SECRET_KEY="your-generated-secret"
API_CRYPTO_KEY="your-generated-hex-key"
API_JWT_SECRET="your-generated-secret"
API_JWT_REFRESHSECRET="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 Groq (Modo Fixo) 
API_LLM_PROVIDER_MODEL="llama-3.3-70b-versatile"             # Escolha seu modelo preferido
API_OPENAI_FORCE_BASE_URL="https://api.groq.com/openai/v1"   # URL da API Groq
API_OPEN_AI_API_KEY="your-groq-api-key"                      # Sua Chave de API Groq

# 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 o Groq porque ele fornece APIs compatíveis com OpenAI com inferência ultrarrápida. Isso oferece o melhor desempenho com configuração simples.

​
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.

​
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 o Groq

Além da verificação básica de instalação, confirme que o Groq está funcionando: 
# Verificar especificamente a conexão com a API Groq
docker-compose logs api worker | grep -i groq
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 Groq
  • Verifique se você tem créditos ou cota suficientes na sua conta Groq
  • 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 na lista de modelos atual do Groq
  • Tente com um modelo diferente da nossa lista recomendada
  • Verifique se o seu servidor tem acesso à internet para alcançar api.groq.com
  • Verifique se há restrições de firewall
  • Revise os logs da API/worker para mensagens de erro detalhadas