Docker Compose

This guide will walk you through deploying Sourcebot locally or on a VM using Docker Compose. We will use the docker-compose.yml file from the Sourcebot repository. This is the simplest way to get started with Sourcebot.

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

Get started

1. Requirements

   • docker & docker compose. Use Docker Desktop on Mac or Windows.
2. 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
   
3. 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
   
4. Launch your instance

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

   docker compose up
   
5. Done

   You’re all set! Navigate to http://localhost:3000 to access your Sourcebot instance.

Next steps