Snyk Broker - Essentials

Prerequisites

If your SCM instance is not publicly accessible, you need Snyk Broker. You can install and configure Snyk Broker using Docker or Helm. The minimum supported Broker version for Snyk Essentials is 4.171.0.

Ensure you have the Snyk Broker token for the Snyk Essentials integration. The Snyk support team can provide the needed token, or you can generate it yourself by following these instructions:

• Generate your Broker token by following the instructions from the Obtain your Broker token for Snyk Broker page.

• Copy and paste the Broker token on the integration setup menu from the Integration Hub.

SCM integrations

• GitHub - install and configure Snyk Broker

  • using Docker

  • using Helm

  • environment variables

• GitHub Enterprise - install and configure Snyk Broker:

  • using Docker

  • using Helm

  • environment variables

• BitBucket - install and configure Snyk Broker:

  • using Docker

  • using Helm

  • environment variables

• GitLab - install and configure Snyk Broker:

  • using Docker

  • using Helm

  • environment variables

• Azure - install and configure Snyk Broker:

  • using Docker

  • using Helm

  • environment variables

You can find on GitHub all the updated .json files that include the allowed list of accessible endpoints for the integrations.

As the final step following a completed Broker setup, for any brokered integration you want to add to Snyk Essentials, you must obtain the Broker token. You can find the Broker token in your Organization integration general settings for your integration type, for example, GitHub, GitLab, and so on, as shown in the following image. For third-party integrations, see the next section.

Broker token in GitLab integration general settings