Deploy using our CLI

​

System Requirements

Note: 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.

​

Installation Guide

​

1. Installing the CLI

npm install -g @kodus/cli

​

2. Installation Process

Detailed walkthrough of the kodus install command, including:

• Required configuration inputs
• Database setup options (local/external)
• AI API configuration (Google Vertex, OpenAI, Novita AI)
• Environment variables setup

​

LLM API Keys Resources

When prompted during installation, you’ll need API keys for AI providers. Use these official resources:

​

3. Setting Up a Reverse Proxy

To make your Kodus instance accessible from external systems (required for Code Review webhooks), you’ll need to configure a reverse proxy with Nginx.

Here’s a sample Nginx configuration:

server {
    listen 80;
    server_name kodus.yourdomain.com;

    location / {
        proxy_pass http://localhost:3000;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }

    location /api {
        proxy_pass http://localhost:3001;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
    }
}

Save this configuration to /etc/nginx/sites-available/kodus and create a symbolic link to enable it:

sudo ln -s /etc/nginx/sites-available/kodus /etc/nginx/sites-enabled/
sudo nginx -t  # Test the configuration
sudo systemctl reload nginx  # Apply the changes

​

Post-Installation Guide

After successfully installing Kodus with the CLI, follow these steps to get the most out of your deployment:

​

Completing Initial Setup

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

​

Updating Kodus

To update your Kodus installation to the latest version:

# Pull the latest images
docker-compose pull

# Restart the services with the new images
docker-compose up -d

​

Enabling SSL (Recommended)

For production deployments, we strongly recommend setting up SSL:

# Install Certbot for Let's Encrypt
sudo apt-get update
sudo apt-get install certbot python3-certbot-nginx

# Obtain and install certificates
sudo certbot --nginx -d kodus.yourdomain.com

​

Accessing Service Logs

​

Troubleshooting Common Issues