diff --git a/openhands/usage/advanced/configuration-options.mdx b/openhands/usage/advanced/configuration-options.mdx index 13f3523b..21336992 100644 --- a/openhands/usage/advanced/configuration-options.mdx +++ b/openhands/usage/advanced/configuration-options.mdx @@ -128,6 +128,13 @@ Core configuration options can be set as environment variables by converting to - Default: `""` - Description: Path to rewrite the workspace mount path to. You can usually ignore this, it refers to special cases of running inside another container. **Deprecated: Use `SANDBOX_VOLUMES` instead.** +### Git Integrations +- `bitbucket_mode` + - Type: `"cloud" | "server"` + - Default: `"cloud"` + - Description: Select the Bitbucket API to target globally. Set to `"server"` when connecting to Bitbucket Data Center/Server deployments. + - Environment variable: `BITBUCKET_MODE` + ### Miscellaneous - `run_as_openhands` - Type: `bool` @@ -435,6 +442,18 @@ All security configuration options can be set as environment variables by prefix - Default: `""` - Description: The security analyzer to use +## Secrets Store and Git Provider Tokens + +You can manage long-lived Git credentials in the `[secrets_store.provider_tokens]` section of `config.toml`. +Each provider (`github`, `gitlab`, `bitbucket`) accepts a table with provider-specific options. + +To enable Bitbucket Server/Data Center support, set the global mode in the `[core]` section: + +```toml +[core] +bitbucket_mode = "server" +``` + --- > **Note**: Adjust configurations carefully, especially for memory, security, and network-related settings to ensure optimal performance and security. diff --git a/openhands/usage/environment-variables.mdx b/openhands/usage/environment-variables.mdx index cf4efde3..09ac42bd 100644 --- a/openhands/usage/environment-variables.mdx +++ b/openhands/usage/environment-variables.mdx @@ -33,6 +33,7 @@ These variables correspond to the `[core]` section in `config.toml`: | `FILE_UPLOADS_ALLOWED_EXTENSIONS` | list | `[".*"]` | List of allowed file extensions for uploads | | `MAX_BUDGET_PER_TASK` | float | `0.0` | Maximum budget per task (0.0 = no limit) | | `MAX_ITERATIONS` | integer | `100` | Maximum number of iterations per task | +| `BITBUCKET_MODE` | string | `"cloud"` | Bitbucket API mode (`cloud` or `server`) used for git integrations | | `RUNTIME` | string | `"docker"` | Runtime environment (`docker`, `local`, `cli`, etc.) | | `DEFAULT_AGENT` | string | `"CodeActAgent"` | Default agent class to use | | `JWT_SECRET` | string | auto-generated | JWT secret for authentication | @@ -248,4 +249,4 @@ export DEBUG_RUNTIME=true docker run -e LLM_API_KEY="your-key" -e DEBUG=true openhands/openhands ``` -6. **Validation**: Invalid environment variable values will be logged as errors and fall back to defaults. \ No newline at end of file +6. **Validation**: Invalid environment variable values will be logged as errors and fall back to defaults. diff --git a/openhands/usage/settings/integrations-settings.mdx b/openhands/usage/settings/integrations-settings.mdx index 774148c2..016a8bde 100644 --- a/openhands/usage/settings/integrations-settings.mdx +++ b/openhands/usage/settings/integrations-settings.mdx @@ -117,7 +117,7 @@ OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment if pro -#### BitBucket Setup +#### BitBucket Cloud Setup 1. **Generate an App password**: @@ -140,4 +140,8 @@ OpenHands automatically exports a `GITLAB_TOKEN` to the shell environment if pro - Verify the token has the required scopes. - \ No newline at end of file + + +#### BitBucket Server Setup (experimental) + +To integrate with a BitBucket server instance, create a Personal Access Token and see the docs for [configuration options](/openhands/usage/advanced/configuration-options) under "Secrets Store and Git Provider Tokens".