"
}
}
}
```
1. Copy the _Consumer Key_ you generated before to the `oauth.consumerKey` field and the output of the command `base64 sourcegraph.pem | tr -d '\n'` to the `oauth.signingKey` field. Finally, **save the configuration**. You're done!
### Fast permission sync with Bitbucket Server plugin
By installing the [Bitbucket Server plugin](/integration/bitbucket-server), you can make use of the fast permission sync feature that allows using Bitbucket Server / Bitbucket Data Center permissions on larger instances.
### Fast permission syncing
With the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket-server#sourcegraph-bitbucket-server-plugin) you can enable fast permission syncing:
1. Connect Bitbucket Server / Bitbucket Data Center to Sourcegraph (_see instructions above_).
1. Follow the [instructions to set up repository permissions](#repository-permissions) with Bitbucket Server / Bitbucket Data Center.
1. Install the [Sourcegraph Bitbucket Server plugin](/integration/bitbucket-server#sourcegraph-bitbucket-server-plugin) on your Bitbucket Server / Bitbucket Data Center instance.
1. In Sourcegraph, go to **Site admin > Manage code hosts** and edit the Bitbucket Server / Bitbucket Data Center configuration.
1. Add the `"plugin.permissions"` property:
```json
{
// [...]
"plugin": {
"permissions": "enabled"
}
}
```
### Authentication for older Bitbucket Server / Bitbucket Data Center versions
Bitbucket Server / Bitbucket Data Center versions older than v5.5 require specifying a less secure username and password combination, as those versions of Bitbucket Server / Bitbucket Data Center do not support [personal access tokens](https://confluence.atlassian.com/bitbucketserver/personal-access-tokens-939515499.html).
### HTTPS cloning
Sourcegraph by default clones repositories from your Bitbucket Server / Bitbucket Data Center via HTTP(S), using the access token or account credentials you provide in the configuration. The [`username`](/admin/code-hosts/bitbucket-server#configuration) field is always used when cloning, so it is required.
## Internal rate limits
See [Internal rate limits](/admin/code-hosts/rate-limits#internal-rate-limits).
## Configuration
Bitbucket Server / Bitbucket Data Center connections support the following configuration options, which are specified in the JSON editor in the site admin "Manage code hosts" area.
{/* [View page on our docs](/admin/code-hosts/bitbucket-server) to see rendered content.
*/}
### admin/code_hosts/bitbucket_server.schema.json
{/* SCHEMA_SYNC_START: admin/code_hosts/bitbucket_server.schema.json */}
{/* WARNING: This section is auto-generated during releases. Do not edit manually. */}
{/* Last updated: 2026-04-02T22:07:28Z */}
```json
// Authentication alternatives: token OR password
{
// If non-null, enforces Bitbucket Server / Bitbucket Data Center repository permissions.
"authorization": {
"identityProvider": {
"type": null
},
"oauth": {
"consumerKey": null,
"signingKey": null
},
"oauth2": false
},
// ⚠️ DEPRECATED: DEPRECATED: Use the tls.external setting in site config
// DEPRECATED: Use the tls.external setting in site config
// Other example values:
// - "-----BEGIN CERTIFICATE-----\n..."
"certificate": null,
// A list of repositories to never mirror from this Bitbucket Server / Bitbucket Data Center instance. Takes precedence over "repos" and "repositoryQuery".
// Supports excluding by name ({"name": "projectKey/repositorySlug"}) or by ID ({"id": 42}).
// Other example values:
// - [
// {
// "name": "myproject/myrepo"
// },
// {
// "id": 42
// }
// ]
// - [
// {
// "name": "myproject/myrepo"
// },
// {
// "name": "myproject/myotherrepo"
// },
// {
// "name": "~USER/theirrepo"
// },
// {
// "pattern": "^topsecretproject/.*"
// }
// ]
"exclude": null,
// Whether or not personal repositories should be excluded or not. When true, Sourcegraph will ignore personal repositories it may have access to. See https://sourcegraph.com/docs/integration/bitbucket_server#excluding-personal-repositories for more information.
"excludePersonalRepositories": false,
// SSH cipher to use when cloning via SSH. Must be a valid choice from `ssh -Q cipher`.
"gitSSHCipher": null,
// SSH keys to use when cloning Git repo.
"gitSSHCredential": null,
// The type of Git URLs to use for cloning and fetching Git repositories on this Bitbucket Server / Bitbucket Data Center instance.
// If "http", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form http(s)://bitbucket.example.com/scm/myproject/myrepo.git (using https: if the Bitbucket Server / Bitbucket Data Center instance uses HTTPS).
// If "ssh", Sourcegraph will access Bitbucket Server / Bitbucket Data Center repositories using Git URLs of the form ssh://git@example.bitbucket.org/myproject/myrepo.git. See the documentation for how to provide SSH private keys and known_hosts: https://sourcegraph.com/docs/admin/repo/auth.
// Valid options: "http", "ssh"
// Other example values:
// - "ssh"
"gitURLType": "http",
// The maximum number of repos that will be deleted per sync. A value of 0 or less indicates no maximum.
"maxDeletions": 0,
// The password to use when authenticating to the Bitbucket Server / Bitbucket Data Center instance. Also set the corresponding "username" field.
// For Bitbucket Server / Bitbucket Data Center instances that support personal access tokens (Bitbucket Server / Bitbucket Data Center version 5.5 and newer), it is recommended to provide a token instead (in the "token" field).
"password": null,
// Configuration for Bitbucket Server / Bitbucket Data Center Sourcegraph plugin
"plugin": {
"permissions": "disabled",
"webhooks": {
"disableSync": false,
"secret": null
}
},
// An array of project key strings that defines a collection of repositories related to their associated project keys
"projectKeys": null,
// Rate limit applied when making background API requests to BitbucketServer.
"rateLimit": {
"enabled": true,
"requestsPerHour": 28800
},
// An array of repository "projectKey/repositorySlug" strings specifying repositories to mirror on Sourcegraph.
// Other example values:
// - [
// "myproject/myrepo",
// "myproject/myotherrepo",
// "~USER/theirrepo"
// ]
"repos": null,
// The pattern used to generate the corresponding Sourcegraph repository name for a Bitbucket Server / Bitbucket Data Center repository.
// - "{host}" is replaced with the Bitbucket Server / Bitbucket Data Center URL's host (such as bitbucket.example.com)
// - "{projectKey}" is replaced with the Bitbucket repository's parent project key (such as "PRJ")
// - "{repositorySlug}" is replaced with the Bitbucket repository's slug key (such as "my-repo").
// For example, if your Bitbucket Server / Bitbucket Data Center is https://bitbucket.example.com and your Sourcegraph is https://src.example.com, then a repositoryPathPattern of "{host}/{projectKey}/{repositorySlug}" would mean that a Bitbucket Server / Bitbucket Data Center repository at https://bitbucket.example.com/projects/PRJ/repos/my-repo is available on Sourcegraph at https://src.example.com/bitbucket.example.com/PRJ/my-repo.
// It is important that the Sourcegraph repository name generated with this pattern be unique to this code host. If different code hosts generate repository names that collide, Sourcegraph's behavior is undefined.
// Other example values:
// - "{projectKey}/{repositorySlug}"
"repositoryPathPattern": "{host}/{projectKey}/{repositorySlug}",
// An array of strings specifying which repositories to mirror on Sourcegraph. Each string is a URL query string with parameters that filter the list of returned repos. Examples: "?name=my-repo&projectname=PROJECT&visibility=private".
// The special string "none" can be used as the only element to disable this feature. Repositories matched by multiple query strings are only imported once. Here's the official Bitbucket Server / Bitbucket Data Center documentation about which query string parameters are valid: https://docs.atlassian.com/bitbucket-server/rest/6.1.2/bitbucket-rest.html#idp355
// Other example values:
// - [
// "?name=my-repo\u0026projectname=PROJECT\u0026visibility=private"
// ]
"repositoryQuery": [
"none"
],
// A Bitbucket Server / Bitbucket Data Center personal access token with Read permissions. When using batch changes, the token needs Write permissions. Create one at https://[your-bitbucket-hostname]/plugins/servlet/access-tokens/add. Also set the corresponding "username" field.
// For Bitbucket Server / Bitbucket Data Center instances that don't support personal access tokens (Bitbucket Server / Bitbucket Data Center version 5.4 and older), specify user-password credentials in the "username" and "password" fields.
"token": null,
// REQUIRED:
// URL of a Bitbucket Server / Bitbucket Data Center instance, such as https://bitbucket.example.com.
// Other example values:
// - "https://bitbucket.example.com"
"url": null,
// REQUIRED:
// The username to use when authenticating to the Bitbucket Server / Bitbucket Data Center instance. Also set the corresponding "token" or "password" field.
"username": null,
// ⚠️ DEPRECATED: DEPRECATED: See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice
// DEPRECATED: See https://sourcegraph.com/docs/admin/config/webhooks/incoming#deprecation-notice
"webhooks": {
"secret": null
}
}
```
{/* SCHEMA_SYNC_END: admin/code_hosts/bitbucket_server.schema.json */}