Bitbucket Server/Data Center - install and configure using Docker
Follow the instructions on this page to set up Bitbucket Server/Data Center with Snyk Broker. This integration is useful to ensure a secure connection with your on-premise Bitbucket deployment.
Prerequisites
Ask your Snyk account team to provide you with a Broker token.
You need Docker or a way to run Docker Linux containers. Some Docker deployments for Windows run only Windows containers. Ensure that your deployment is capable of running Linux containers.
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 for Snyk Broker for definitions of the environment variables.If necessary, go to the Advanced configuration page 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. See also Adding custom accept.json for Docker installation.
Copy the following command to set up a fully configured Broker Client to analyze Open Source, IaC, Container, and Code files (with the Code Agent).
docker run --restart=always \
-p 8000:8000 \
-e BROKER_TOKEN=<secret-broker-token> \
-e BITBUCKET_USERNAME=<username> \
-e BITBUCKET_PASSWORD=<password> \
-e BITBUCKET=<your.bitbucket-server.domain.com (no http/s)> \
-e BITBUCKET_API=<your.bitbucket-server.domain.com/rest/api/1.0 (no http/s)> \
-e PORT=8000 \
-e BROKER_CLIENT_URL=<http://broker.url.example:8000 (dns/IP:port)> \
-e ACCEPT_IAC=tf,yaml,yml,json,tpl \
-e ACCEPT_CODE=true \
snyk/broker:bitbucket-server
As an alternative to using the Docker run command, you can use a derived Docker image to set up the Broker Client integration. See Derived Docker images for the environment variables to override for the BitBucket Server/Data Center integration.
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- Run
docker logs <container id>to look for any errors, where container id is the Bitbucket Broker container ID. - Ensure relevant ports are exposed to Bitbucket.