Docker Compose

This guide will walk you through deploying Sourcebot locally or on a VM using Docker Compose. This is the simplest way to get started with Sourcebot.

If you are looking to deploy onto Kubernetes, see the Kubernetes (Helm) guide.

System requirements

• RAM: Ensure your environment has at least 4GB of RAM. Insufficient memory can cause processes to crash.
• Docker & Docker Compose: Make sure both are installed and up-to-date.
• Node.js 18+: Required for the setup CLI

Option 1: Setup CLI

The setup CLI will guide you through configuring your Sourcebot instance to connect to your code hosts and LLM providers. From a empty folder, run the following command:

npx setup-sourcebot

Option 2: Manual steps

Obtain the Docker Compose file

Download the docker-compose.yml file from the Sourcebot repository.

curl -o docker-compose.yml https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/docker-compose.yml

Create a config.json

In the same directory as the docker-compose.yml file, create a configuration file. The configuration file is a JSON file that configures Sourcebot’s behaviour, including what repositories to index, language model providers, auth providers, and more.

Create example config

touch config.json
echo '{
    "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
    // Comments are supported.
    // This config creates a single connection to GitHub.com that
    // indexes the Sourcebot repository
    "connections": {
        "starter-connection": {
            "type": "github",
            "repos": [
                "sourcebot-dev/sourcebot"
            ]
        }
    }
}' > config.json

Launch your instance

Update the secrets in the docker-compose.yml and then run Sourcebot using:

docker compose up

Navigate to http://localhost:3000 to access your Sourcebot instance.

Next steps