When self-hosting Sourcebot, you must provide it a config file. This is done by defining a config file in a volume that’s mounted to Sourcebot, and providing the path to this file in the CONFIG_PATH environment variable. For example:

Passing in a CONFIG_PATH to Sourcebot

docker run \
    -v $(pwd)/config.json:/data/config.json \
    -e CONFIG_PATH=/data/config.json \
    ... \ # other options
    docker.sourcebot.dev/sourcebot-dev/sourcebot:latest

The config file tells Sourcebot which repos to index, what language models to use, and various other settings as defined in the schema.

Config File Schema

The config file you provide Sourcebot must follow the schema. This schema consists of the following properties:

Connections (connections): Defines a set of connections that tell Sourcebot which repos to index and from where
Language Models (models): Defines a set of language model providers for use with Ask Sourcebot
Settings (settings): Additional settings to tweak your Sourcebot deployment
Search Contexts (contexts): Groupings of repos that you can search against

Config File Syncing

Sourcebot syncs the config file on startup, and automatically whenever a change is detected.

Settings

The following are settings that can be provided in your config file to modify Sourcebot’s behavior

Setting	Type	Default	Minimum	Description / Notes
`maxFileSize`	number	2 MB	1	Maximum size (bytes) of a file to index. Files exceeding this are skipped.
`maxTrigramCount`	number	20 000	1	Maximum trigrams per document. Larger files are skipped.
`reindexIntervalMs`	number	1 hour	1	Interval at which all repositories are re‑indexed.
`resyncConnectionIntervalMs`	number	24 hours	1	Interval for checking connections that need re‑syncing.
`resyncConnectionPollingIntervalMs`	number	1 second	1	DB polling rate for connections that need re‑syncing.
`reindexRepoPollingIntervalMs`	number	1 second	1	DB polling rate for repos that should be re‑indexed.
`maxConnectionSyncJobConcurrency`	number	8	1	Concurrent connection‑sync jobs.
`maxRepoIndexingJobConcurrency`	number	8	1	Concurrent repo‑indexing jobs.
`maxRepoGarbageCollectionJobConcurrency`	number	8	1	Concurrent repo‑garbage‑collection jobs.
`repoGarbageCollectionGracePeriodMs`	number	10 seconds	1	Grace period to avoid deleting shards while loading.
`repoIndexTimeoutMs`	number	2 hours	1	Timeout for a single repo‑indexing run.
`repoDrivenPermissionSyncIntervalMs`	number	24 hours	1	Interval at which the repo permission syncer should run.
`userDrivenPermissionSyncIntervalMs`	number	24 hours	1	Interval at which the user permission syncer should run.
`experiment_repoDrivenPermissionSyncIntervalMs` (deprecated)	number	24 hours	1	Use `repoDrivenPermissionSyncIntervalMs` instead.
`experiment_userDrivenPermissionSyncIntervalMs` (deprecated)	number	24 hours	1	Use `userDrivenPermissionSyncIntervalMs` instead.
`maxAccountPermissionSyncJobConcurrency`	number	8	1	Concurrent account permission sync jobs.
`maxRepoPermissionSyncJobConcurrency`	number	8	1	Concurrent repo permission sync jobs.

Tokens

Tokens are used to securely pass secrets to Sourcebot in a config file. They are used in various places, including connections, language model providers, auth providers, etc. Tokens can be passed as either environment variables or Google Cloud secrets:

Environment Variables

{
    "token": {
        "env": "TOKEN_NAME"
    }
}

Google Cloud Secrets

{
    "token": {
        "googleCloudSecret": "projects/<project-id>/secrets/<secret-name>/versions/<version-id>"
    }
}

Overriding environment variables from the config

You can override / set environment variables from the config file by using the environmentOverrides property. Overrides can be of type string, number, boolean, or a token. Tokens are useful when you want to configure a environment variable using a Google Cloud Secret or other supported secret management service.

Token

{
    "environmentOverrides": {
        "DATABASE_URL": {
            "type": "token",
            "value": {
                "googleCloudSecret": "projects/<id>/secrets/postgres-connection-string/versions/latest"
            }
        },
        "REDIS_URL": {
            "type": "token",
            "value": {
                "googleCloudSecret": "projects/<id>/secrets/redis-connection-string/versions/latest"
            }
        }
    },
}

String

{
    "environmentOverrides": {
        "EMAIL_FROM_ADDRESS": {
            "type": "string",
            "value": "hello@sourcebot.dev"
        }
    }
}

Number

{
    "environmentOverrides": {
        "SOURCEBOT_CHAT_MODEL_TEMPERATURE": {
            "type": "number",
            "value": 0.5
        }
    }
}

Boolean

{
    "environmentOverrides": {
        "SOURCEBOT_TELEMETRY_DISABLED": {
            "type": "boolean",
            "value": false
        }
    }
}

Note: Overrides are not set as system environment variables, and instead are resolved at runtime on startup and stored in memory.

Schema reference

schemas/v3/environmentOverrides.json

{
  "type": "object",
  "description": "Environment variable overrides.",
  "title": "EnvironmentOverrides",
  "not": {
    "$comment": "List of environment variables that are not allowed to be overridden.",
    "anyOf": [
      {
        "required": [
          "CONFIG_PATH"
        ]
      }
    ]
  },
  "patternProperties": {
    "^[a-zA-Z0-9_-]+$": {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "type": {
              "const": "token"
            },
            "value": {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "env": {
                      "type": "string",
                      "description": "The name of the environment variable that contains the token."
                    }
                  },
                  "required": [
                    "env"
                  ],
                  "additionalProperties": false
                },
                {
                  "type": "object",
                  "properties": {
                    "googleCloudSecret": {
                      "type": "string",
                      "description": "The resource name of a Google Cloud secret. Must be in the format `projects/<project-id>/secrets/<secret-name>/versions/<version-id>`. See https://cloud.google.com/secret-manager/docs/creating-and-accessing-secrets"
                    }
                  },
                  "required": [
                    "googleCloudSecret"
                  ],
                  "additionalProperties": false
                }
              ]
            }
          },
          "required": [
            "type",
            "value"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "const": "string"
            },
            "value": {
              "type": "string"
            }
          },
          "required": [
            "type",
            "value"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "const": "number"
            },
            "value": {
              "type": "number"
            }
          },
          "required": [
            "type",
            "value"
          ],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "type": {
              "const": "boolean"
            },
            "value": {
              "type": "boolean"
            }
          },
          "required": [
            "type",
            "value"
          ],
          "additionalProperties": false
        }
      ]
    }
  }
}

Getting Started

Features

Configuration

Subscribe

Misc

Upgrade

Config File

Config File Schema

Config File Syncing

Settings

Tokens

Overriding environment variables from the config

​Config File Schema

​Config File Syncing

​Settings

​Tokens

​Overriding environment variables from the config

Config File Schema

Config File Syncing

Settings

Tokens

Overriding environment variables from the config