> For the complete documentation index, see [llms.txt](https://docs.snyk.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.snyk.io/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/bitbucket-server-data-center-install-and-configure-using-docker.md). # Bitbucket Server/Data Center - install and configure using Docker How to install and configure Snyk Broker for Bitbucket Server and Data Center using Docker Before installing, review the [prerequisites](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker.md) and the general instructions for installation using [Docker](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/install-and-configure-broker-using-docker.md). This integration is useful to ensure a secure connection with your on-premise Bitbucket deployment. This page describes two distinct authentication schemes: using [Basic Auth](#configure-broker-to-be-used-with-bitbucket-using-basic-auth) and [using an API token](#configure-broker-to-be-used-with-bitbucket-using-an-api-token). Your Bitbucket Server settings might preclude Basic Auth usage, in which case Bearer Auth is preferred. ## Configure Broker to be used with Bitbucket using Basic Auth The following explains how to configure Snyk Broker to use the Broker Client with a Bitbucket Server deployment. To use the Snyk Broker Client with BitBucket, run `docker pull snyk/broker:bitbucket-server`. Refer to [BitBucket Server/Data Center - environment variables](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/bitbucket-server-data-center-environment-variables-for-snyk-broker-basic-auth.md) for Snyk Broker for definitions of the environment variables. If necessary, navigate to the [Advanced configuration page](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation.md) and make any configuration changes needed, such as providing the CA (Certificate Authority) to the Broker Client configuration if the Bitbucket instance is using a private certificate, and setting up [proxy support](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation/proxy-support-with-docker.md). ## Docker run command to set up a Broker Client for Bitbucket using Basic Auth Copy the following command to set up a fully configured Broker Client to analyze Open Source, IaC, Container, Code files, and Snyk Essentials information. {% hint style="info" %} **Multi-tenant settings for regions**\ When installing, you must add a command in your script to set the `BROKER_SERVER_URL`. This is the URL of the Broker server for the region where your data is hosted. For the commands and URLs to use, see [Broker URLs](/snyk-data-and-governance/regional-hosting-and-data-residency.md#broker-server-urls). {% endhint %} ```bash docker run --restart=always \ -p 8000:8000 \ -e BROKER_TOKEN= \ -e BROKER_SERVER_URL= \ -e BITBUCKET_USERNAME= \ -e BITBUCKET_PASSWORD= \ -e BITBUCKET= \ -e BITBUCKET_API= \ -e PORT=8000 \ -e BROKER_CLIENT_URL= \ -e ACCEPT_IAC=tf,yaml,yml,json,tpl \ -e ACCEPT_CODE=true \ -e ACCEPT_Essentials=true \ snyk/broker:bitbucket-server ``` {% hint style="info" %} Snyk Essentials is set by default to **`false`**. Enable it by setting the flag to **`true`**. {% endhint %} ## Configure Broker to be used with Bitbucket using an API token The following explains how to configure Snyk Broker to use the Broker Client with a Bitbucket Server deployment using an API token. To use the Snyk Broker Client with BitBucket, **run** `docker pull snyk/broker:bitbucket-server-bearer-auth`. For definitions of the environment variables, refer to [Bitbucket Server/Data Center - environment variables for Snyk Broker Basic Auth](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/bitbucket-server-data-center-environment-variables-for-snyk-broker-basic-auth.md) and [Bitbucket Server/Data Center - environment variables for Snyk Broker Personal Access Token (PAT)](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/bitbucket-server-data-center-environment-variables-for-snyk-broker-personal-access-token-pat.md). If necessary, go to the [Advanced configuration page](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation.md) and make any configuration changes needed, such as providing the CA (Certificate Authority) to the Broker Client configuration if the Bitbucket instance is using a private certificate, and setting up [proxy support](/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation/proxy-support-with-docker.md). ## Docker run command to set up a Broker Client for Bitbucket using a PAT Copy the following command to set up a fully configured Broker Client to analyze Open Source, IaC, Container, Code files, and Snyk Essentials information. Enable Snyk Essentials to identify your application assets, monitor them, and prioritize the risks. ```bash docker run --restart=always \ -p 8000:8000 \ -e BROKER_TOKEN= \ -e BITBUCKET_PAT= \ -e BITBUCKET= \ -e BITBUCKET_API= \ -e PORT=8000 \ -e BROKER_CLIENT_URL= \ -e ACCEPT_IAC=tf,yaml,yml,json,tpl \ -e ACCEPT_CODE=true \ -e ACCEPT_Essentials=true \ snyk/broker:bitbucket-server-bearer-auth ``` {% hint style="info" %} Snyk Essentials is set by default to `false`. Enable it by setting the flag to `true`. {% endhint %} ## Start the Broker Client container and verify the connection with Bitbucket Paste the Broker Client configuration to start the Broker Client container. Once the container is up, the Bitbucket Integrations page shows the connection to Bitbucket, and you can `Add Projects` ## Basic troubleshooting for Broker with BitBucket * Run `docker logs ` to look for any errors, where `container id` is the Bitbucket Broker container ID. * Ensure relevant ports are exposed to Bitbucket. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.snyk.io/platform-administration/snyk-broker/classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/bitbucket-server-data-center-install-and-configure-using-docker.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.