Install and configure Broker using Docker

Before starting installation, review the Prerequisites and other information on the page Prepare Snyk Broker for deployment.

If you are using Kubernetes, Snyk recommends that you install Snyk Broker with the Broker Helm Chart. For details, see Install and configure Broker using Helm.

For all other environments, you can install Snyk Broker using the Docker images provided by Snyk. The pages listed here explain how to set up the Snyk Broker Client integrations using Docker.

Install using Docker

The following pages explain how to install these special integrations.

• GitHub

• GitHub Enterprise

• Bitbucket Server/Data Centre

• Gitlab

• Azure Repos

• JFrog Artifactory Repository

• Nexus Repository Manager

• Jira

• Snyk Broker - Container Registry Agent (needed to connect to Container Registries)

• Derived Docker images for Broker Client integrations and Container Registry Agent

You can customize the configuration using the environment variables in the Docker images. For this reason, install separate, multiple instances of the Broker Client for different integration types to ensure proper configuration as well as redundancy.

You can verify that the Broker is running by looking at the settings for your brokered integration in the Snyk Web UI to see a confirmation message that you are connected. You can start importing Projects once you are connected.

Advanced configuration using Docker

When you install using Docker, follow the instructions in the pages on Advanced configuration for Snyk Broker Docker installation as needed.