Snyk Code - Clone capability with Broker for Docker

Release status

The environment variable to enable Git clone capabilities is in Closed Beta. However, it is the preferred way to run Snyk Code analysis through the Broker and is fully capable.

If you are interested in using the feature, contact your Snyk account team.

Brokered Snyk Code enables the Broker to accept code files, and the Broker then scans between the SCM system and Snyk.

By default, the Git clone capabilities required by Snyk Code are disabled.

Accept configuration

To grant Broker access to perform a Git clone of your repository, add the environment variable: ACCEPT_CODE=true

Example:

docker run --restart=always \
           -p 8000:8000 \
           -e BROKER_TOKEN=secret-broker-token \
           -e GITHUB_TOKEN=secret-github-token \
           -e PORT=8000 \
           -e BROKER_CLIENT_URL=http://my.broker.client:8000 \
           -e ACCEPT_CODE=true
       snyk/broker:github-com

This adds the necessary accept rules for your Git server.

After this is done, you can follow the Broker instructions for your SCM system. For details, see Install and configure Snyk Broker

Custom accept configuration

The default rules are in the client templates in the Broker GitHub repository.

If custom accept rules are required, you can provide a custom accept.json.

Example:

docker run --restart=always \
           -p 8000:8000 \
           -e BROKER_TOKEN=secret-broker-token \
           -e GITHUB_TOKEN=secret-github-token \
           -e PORT=8000 \
           -e BROKER_CLIENT_URL=http://my.broker.client:8000 \
           -e ACCEPT=/myFolder/accept.json
       snyk/broker:github-com

If you are using a custom accept file from a separate folder, with the ACCEPT environment variable, you cannot use any of the other ACCEPT mechanisms, such as ACCEPT_CODE or ACCEPT_IAC.

If you want to customize the accept.json, add this snippet to your custom accept.json

{
    "//": "used to redirect requests to snyk git client",
    "method": "any",
    "path": "/snykgit/*",
    "origin": "${GIT_CLIENT_URL}"
}

This snippet is valid for all Git integrations.