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.
Groqの動作方法
Groq CloudはOpenAI互換APIで高速なLLM推論を提供します。スピードとシンプルさのために構築されたGroqは、Llama、DeepSeekなどの人気モデルへの超高速推論を提供します。プラットフォームはシンプルに統合してスケールしやすいように設計されており、本番アプリケーションに最適です。推奨モデル
高いコンテキストウィンドウと高速推論を持つ優れたコーディングモデルを推奨します。最新情報については、Groqのモデルページを参照してください。
| モデル | コンテキストウィンドウ | 速度 |
|---|---|---|
Llama 3.3 70B Versatile 推奨 | 約128kトークン | 超高速 |
| Deepseek R1 Distill Llama 70B | 約128kトークン | 超高速 |
| Llama 3.1 70B Versatile | 約128kトークン | 超高速 |
APIキーの作成
GroqのAPIキーページに直接アクセスして新しいAPIキーを作成します。 または、以下の手順に従ってください:- Groqコンソールにアクセスします
- サインインするかアカウントを作成します
- 上部ナビゲーションで「APIキー」に移動します
- 「APIキーを作成」ボタンをクリックします
- 「Kodus」または任意の説明的な名前を付けます
- APIキーをコピーして安全な場所に保存します
GroqのAPIキーを作成または管理できるのは、チームオーナーまたはデベロッパーロールを持つユーザーのみです。
使用方法
System Requirements
Recommended Hardware
Recommended Hardware
Sized for the default
local sandbox mode (kodus-graph + cross-file
context run inside the worker container).- CPU: 2+ cores (4+ recommended for repos above ~100k LOC)
- RAM: 8GB+ (16GB recommended when running the
localsandbox on large repos) - Storage: 60GB+ free space (Postgres holds the AST graph cache; grows with repo count and PR volume)
Required Software
Required Software
- 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.)
Required Ports
Required Ports
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)
Services
Services
What
./scripts/install.sh brings up, based on your .env.Core (always on):api— main backendworker— code-review jobswebhooks— Git provider webhook receiverkodus-web— Next.js frontenddb_kodus_postgres,db_kodus_mongodb,rabbitmq— local infrastructure. Skip withUSE_LOCAL_DB=false/USE_LOCAL_RABBITMQ=falseto point at managed instances.
kodus-mcp-manager— Model Context Protocol broker. Enable withAPI_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.
- 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.
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
Edit the environment file
Edit See Environment Variables Configuration for detailed instructions.
.env with your values using your preferred text editor.Success 🎉
When complete, Kodus Services should be running on your machine.
You can verify your installation using the following script:
Access the web interface
Once you access the web interface for the first time, you'll need to:
- Create your admin account - This will be the first user with full system access
- Configure your Git provider - Connect GitHub, GitLab, or Bitbucket following the on-screen instructions
- 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.
環境ファイルでGroqを設定する
.env ファイルを編集してコア設定を構成します。LLMインテグレーションには、Groqを固定モードで使用します:
WebhookのURLはWebhooksサービス(ポート3332)に到達できる必要があります。専用webhooksドメインを使用するか、リバースプロキシで
/.../webhook をポート3332にルーティングします。固定モードはGroqに最適です。OpenAI互換APIと超高速推論を提供します。これによりシンプルな設定で最高のパフォーマンスが得られます。
Run the Installation Script
Set the proper permissions for the installation script: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
http://localhost:3000 - you should see the Kodus Web Application interface.
リバースプロキシのセットアップ(本番環境向け)
WebhookとExternal Accessには、Nginxを設定します:Groq統合の確認
基本的なインストール確認に加えて、Groqが動作していることを確認します:トラブルシューティング
APIキーの問題
APIキーの問題
- APIキーがGroqコンソールで正しくアクティブであることを確認します
- Groqアカウントに十分なクレジットまたはクォータがあるか確認します
.envファイルに余分なスペースがないことを確認します
モデルが見つからない
モデルが見つからない
- 設定のモデル名が正しくスペルされていることを確認します
- GroqのCurrentモデルリストでモデルが利用可能であることを確認します
- 推奨リストの別のモデルで試してください
接続エラー
接続エラー
- サーバーが
api.groq.comにアクセスできるインターネット接続を持っていることを確認します - ファイアウォールの制限がないか確認します
- 詳細なエラーメッセージについてAPI/ワーカーログを確認します
レート制限
レート制限
- Groqにはプランに基づいたレート制限があります
- Groqのレート制限ドキュメントを確認します
- より高い制限のためにプランのアップグレードを検討します