Docker (latest stable version) - Node.js (latest LTS version) - Yarn or
NPM (latest stable version) - Domain name or fixed IP (for external
deployments)
Required Ports
3000: Kodus Web App - 3001: Orchestrator API - 5672, 15672: RabbitMQ -
5432: PostgreSQL - 27017: MongoDB
Internet access is only required if you plan to connect with cloud-based Git
services like GitHub, GitLab, or Bitbucket. For self-hosted Git tools within
your network, external internet access is 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.
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.
Clones repositories and configures environment files
Runs docker-compose to start all services
Executes database migrations
Seeds initial data
🎉 Success! When complete, Kodus Orchestrator API and Web Application 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.