Skip to main content
Sourcebot is distributed as a single docker container that can be deployed to a k8s cluster, a VM, or any platform that supports docker. The following guide will walk you through the steps to deploy Sourcebot locally using Docker compose.
Hit an issue? Please let us know on GitHub or by emailing us.

​
Walkthrough

1

Requirements

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

Create a config.json file that tells Sourcebot which repositories to sync and index:
Create example config
touch config.json
echo '{
    "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json",
    "connections": {
        // comments are supported 
        "starter-connection": {
            "type": "github",
            "repos": [
                "sourcebot-dev/sourcebot"
            ]
        }
    }
}' > config.json
This config creates a single GitHub connection named starter-connection that specifies Sourcebot as a repo to sync. Learn more about the config file.
4

Launch your instance

If you’re deploying Sourcebot behind a domain, you must set the AUTH_URL environment variable.
Launch your Sourcebot instance:
docker compose up -d
5

Complete onboarding

Navigate to http://localhost:3000 and complete the onboarding flow.
6

Done

You’re all set! If you’d like to setup Ask Sourcebot, configure a language model provider.
Checkout the configuration docs to learn more about how to configure your deployment.

​
Next steps

Index your code

Learn how to index your code using Sourcebot

Authentication

Learn more about how to setup SSO, email codes, and other authentication providers.
⌘I