-
-
-## Code Formatting
-
-We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
-
-## Troubleshooting
-
-Enables/disables authentication with basic credentials. Username and passwords are stored encrypted at rest within the postgres database. Checkout the [auth docs](/docs/configuration/auth/overview) for more info
| +| `AUTH_EMAIL_CODE_LOGIN_ENABLED` | `false` |Enables/disables authentication with a login code that's sent to a users email. `SMTP_CONNECTION_URL` and `EMAIL_FROM_ADDRESS` must also be set. Checkout the [auth docs](/docs/configuration/auth/overview) for more info
| +| `AUTH_SECRET` | Automatically generated at startup if no value is provided. Generated using `openssl rand -base64 33` |Used to validate login session cookies
| +| `AUTH_URL` | - |URL of your Sourcebot deployment, e.g., `https://example.com` or `http://localhost:3000`.
| +| `CONFIG_PATH` | `-` |The container relative path to the declerative configuration file. See [this doc](/docs/configuration/declarative-config) for more info.
| +| `DATA_CACHE_DIR` | `$DATA_DIR/.sourcebot` |The root data directory in which all data written to disk by Sourcebot will be located.
| +| `DATA_DIR` | `/data` |The directory within the container to store all persistent data. Typically, this directory will be volume mapped such that data is persisted across container restarts (e.g., `docker run -v $(pwd):/data`)
| +| `DATABASE_DATA_DIR` | `$DATA_CACHE_DIR/db` |The data directory for the default Postgres database.
| +| `DATABASE_URL` | `postgresql://postgres@ localhost:5432/sourcebot` |Connection string of your Postgres database. By default, a Postgres database is automatically provisioned at startup within the container.
If you'd like to use a non-default schema, you can provide it as a parameter in the database url
| +| `EMAIL_FROM_ADDRESS` | `-` |The email address that transactional emails will be sent from. See [this doc](/docs/configuration/transactional-emails) for more info.
| +| `FORCE_ENABLE_ANONYMOUS_ACCESS` | `false` |When enabled, [anonymous access](/docs/configuration/auth/access-settings#anonymous-access) to the organization will always be enabled
+| `REDIS_DATA_DIR` | `$DATA_CACHE_DIR/redis` |The data directory for the default Redis instance.
| +| `REDIS_URL` | `redis://localhost:6379` |Connection string of your Redis instance. By default, a Redis database is automatically provisioned at startup within the container.
| +| `REDIS_REMOVE_ON_COMPLETE` | `0` |Controls how many completed jobs are allowed to remain in Redis queues
| +| `REDIS_REMOVE_ON_FAIL` | `100` |Controls how many failed jobs are allowed to remain in Redis queues
| +| `REPO_SYNC_RETRY_BASE_SLEEP_SECONDS` | `60` |The base sleep duration (in seconds) for exponential backoff when retrying repository sync operations that fail
| +| `GITLAB_CLIENT_QUERY_TIMEOUT_SECONDS` | `600` |The timeout duration (in seconds) for GitLab client queries
| +| `SHARD_MAX_MATCH_COUNT` | `10000` |The maximum shard count per query
| +| `SMTP_CONNECTION_URL` | `-` |The url to the SMTP service used for sending transactional emails. See [this doc](/docs/configuration/transactional-emails) for more info.
| +| `SOURCEBOT_ENCRYPTION_KEY` | Automatically generated at startup if no value is provided. Generated using `openssl rand -base64 24` |Used to encrypt connection secrets and generate API keys.
| +| `SOURCEBOT_PUBLIC_KEY_PATH` | `/app/public.pem` |Sourcebot's public key that's used to verify encrypted license key signatures.
| +| `SOURCEBOT_LOG_LEVEL` | `info` |The Sourcebot logging level. Valid values are `debug`, `info`, `warn`, `error`, in order of severity.
| +| `SOURCEBOT_STRUCTURED_LOGGING_ENABLED` | `false` |Enables/disable structured JSON logging. See [this doc](/docs/configuration/structured-logging) for more info.
| +| `SOURCEBOT_STRUCTURED_LOGGING_FILE` | - |Optional file to log to if structured logging is enabled
| +| `SOURCEBOT_TELEMETRY_DISABLED` | `false` |Enables/disables telemetry collection in Sourcebot. See [this doc](/docs/overview.mdx#telemetry) for more info.
| +| `TOTAL_MAX_MATCH_COUNT` | `100000` |The maximum number of matches per query
| +| `ZOEKT_MAX_WALL_TIME_MS` | `10000` |The maximum real world duration (in milliseconds) per zoekt query
| + +### Enterprise Environment Variables +| Variable | Default | Description | +| :------- | :------ | :---------- | +| `SOURCEBOT_EE_AUDIT_LOGGING_ENABLED` | `true` |Enables/disables audit logging
| +| `AUTH_EE_GITHUB_BASE_URL` | `https://github.com` |The base URL for GitHub Enterprise SSO authentication.
| +| `AUTH_EE_GITHUB_CLIENT_ID` | `-` |The client ID for GitHub Enterprise SSO authentication.
| +| `AUTH_EE_GITHUB_CLIENT_SECRET` | `-` |The client secret for GitHub Enterprise SSO authentication.
| +| `AUTH_EE_GITLAB_BASE_URL` | `https://gitlab.com` |The base URL for GitLab Enterprise SSO authentication.
| +| `AUTH_EE_GITLAB_CLIENT_ID` | `-` |The client ID for GitLab Enterprise SSO authentication.
| +| `AUTH_EE_GITLAB_CLIENT_SECRET` | `-` |The client secret for GitLab Enterprise SSO authentication.
| +| `AUTH_EE_GOOGLE_CLIENT_ID` | `-` |The client ID for Google SSO authentication.
| +| `AUTH_EE_GOOGLE_CLIENT_SECRET` | `-` |The client secret for Google SSO authentication.
| +| `AUTH_EE_KEYCLOAK_CLIENT_ID` | `-` |The client ID for Keycloak SSO authentication.
| +| `AUTH_EE_KEYCLOAK_CLIENT_SECRET` | `-` |The client secret for Keycloak SSO authentication.
| +| `AUTH_EE_KEYCLOAK_ISSUER` | `-` |The issuer URL for Keycloak SSO authentication.
| +| `AUTH_EE_OKTA_CLIENT_ID` | `-` |The client ID for Okta SSO authentication.
| +| `AUTH_EE_OKTA_CLIENT_SECRET` | `-` |The client secret for Okta SSO authentication.
| +| `AUTH_EE_OKTA_ISSUER` | `-` |The issuer URL for Okta SSO authentication.
| +| `AUTH_EE_GCP_IAP_ENABLED` | `false` |When enabled, allows Sourcebot to automatically register/login from a successful GCP IAP redirect
| +| `AUTH_EE_GCP_IAP_AUDIENCE` | - |The GCP IAP audience to use when verifying JWT tokens. Must be set to enable GCP IAP JIT provisioning
| + + +### Review Agent Environment Variables +| Variable | Default | Description | +| :------- | :------ | :---------- | +| `GITHUB_APP_ID` | `-` |The GitHub App ID used for review agent authentication.
| +| `GITHUB_APP_PRIVATE_KEY_PATH` | `-` |The container relative path to the private key file for the GitHub App used by the review agent.
| +| `GITHUB_APP_WEBHOOK_SECRET` | `-` |The webhook secret for the GitHub App used by the review agent.
| +| `OPENAI_API_KEY` | `-` |The OpenAI API key used by the review agent.
| +| `REVIEW_AGENT_API_KEY` | `-` |The Sourcebot API key used by the review agent.
| +| `REVIEW_AGENT_AUTO_REVIEW_ENABLED` | `false` |Enables/disables automatic code reviews by the review agent.
| +| `REVIEW_AGENT_LOGGING_ENABLED` | `true` |Enables/disables logging for the review agent. Logs are saved in `DATA_CACHE_DIR/review-agent`
| +| `REVIEW_AGENT_REVIEW_COMMAND` | `review` |The command used to trigger a code review by the review agent.
| + diff --git a/docs/docs/configuration/language-model-providers.mdx b/docs/docs/configuration/language-model-providers.mdx new file mode 100644 index 00000000..d372c83d --- /dev/null +++ b/docs/docs/configuration/language-model-providers.mdx @@ -0,0 +1,291 @@ +--- +title: Language Model Providers +sidebarTitle: Language model providers +--- + +To use [Ask Sourcebot](/docs/features/ask) you must define at least one Language Model Provider. These providers are defined within the [config file](/docs/configuration/config-file) you +provide Sourcebot. + + +```json wrap icon="code" Example config with language model provider +{ + "$schema": "https://raw.githubusercontent.com/sourcebot-dev/sourcebot/main/schemas/v3/index.json", + "models": [ + // 1. Google Vertex config for Gemini 2.5 Pro + { + "provider": "google-vertex", + "model": "gemini-2.5-pro", + "displayName": "Gemini 2.5 Pro", + "project": "sourcebot", + "credentials": { + "env": "GOOGLE_APPLICATION_CREDENTIALS" + } + }, + // 2. OpenAI config for o3 + { + "provider": "openai", + "model": "o3", + "displayName": "o3", + "token": { + "env": "OPENAI_API_KEY" + } + } + ] +} +``` + +# Supported Providers + +Sourcebot uses the [Vercel AI SDK](https://ai-sdk.dev/docs/introduction), so it can integrate with any provider the SDK supports. If you don't see your provider below please submit +a [feature request](https://github.com/sourcebot-dev/sourcebot/discussions/categories/feature-requests). + +For a detailed description of all the providers, please refer to the [schema](https://github.com/sourcebot-dev/sourcebot/blob/main/schemas/v3/languageModel.json). + +
+ 
+ The Sourcebot logging level. Valid values are `debug`, `info`, `warn`, `error`, in order of severity.
| -| `DATABASE_URL` | `postgresql://postgres@ localhost:5432/sourcebot` |Connection string of your Postgres database. By default, a Postgres database is automatically provisioned at startup within the container.
If you'd like to use a non-default schema, you can provide it as a parameter in the database url
| -| `REDIS_URL` | `redis://localhost:6379` |Connection string of your Redis instance. By default, a Redis database is automatically provisioned at startup within the container.
| -| `SOURCEBOT_ENCRYPTION_KEY` | - |Used to encrypt connection secrets. Generated using `openssl rand -base64 24`. Automatically generated at startup if no value is provided.
| -| `AUTH_SECRET` | - |Used to validate login session cookies. Generated using `openssl rand -base64 33`. Automatically generated at startup if no value is provided.
| -| `AUTH_URL` | - |URL of your Sourcebot deployment, e.g., `https://example.com` or `http://localhost:3000`. Required when `SOURCEBOT_AUTH_ENABLED` is `true`.
| -| `SOURCEBOT_TENANCY_MODE` | `single` |The tenancy configuration for Sourcebot. Valid values are `single` or `multi`. See [this doc](/self-hosting/more/tenancy) for more info.
| -| `SOURCEBOT_AUTH_ENABLED` | `false` |Enables/disables authentication in Sourcebot. If set to `false`, `SOURCEBOT_TENANCY_MODE` must be `single`. See [this doc](/self-hosting/more/authentication) for more info.
| -| `SOURCEBOT_TELEMETRY_DISABLED` | `false` |Enables/disables telemetry collection in Sourcebot. See [this doc](/self-hosting/security/telemetry) for more info.
| -| `DATA_DIR` | `/data` |The directory within the container to store all persistent data. Typically, this directory will be volume mapped such that data is persisted across container restarts (e.g., `docker run -v $(pwd):/data`)
| -| `DATA_CACHE_DIR` | `$DATA_DIR/.sourcebot` |The root data directory in which all data written to disk by Sourcebot will be located.
| -| `DATABASE_DATA_DIR` | `$DATA_CACHE_DIR/db` |The data directory for the default Postgres database.
| -| `REDIS_DATA_DIR` | `$DATA_CACHE_DIR/redis` |The data directory for the default Redis instance.
| - - -## Additional Features - -There are additional features that can be enabled and configured via environment variables. - -+ Code navigation is not enabled for router.push(`/${domain}/settings/license`)}>your plan. +
+ + + Learn more + +No symbol selected
+ + Learn more + +{ + setIsRenameDialogOpen(true); + }} + > + {name ?? 'Untitled chat'} +
+Recent Chats
++ + Sign in + to access your chat history. +
+Recent chats will appear here.
+- {/* hack since to make the @ symbol look more centered with the text */} - - @ - - {`${branchDisplayName}`} -
- )} - ยท -Signing in with Google Cloud IAP...
++ {suggestionTypes[selectedSuggestionType].title} +
+ {suggestions[selectedSuggestionType].map(({ queryText, queryNode, openRepoSelector }, index) => ( +