SupportSnyk LearnAPI referenceProduct updatesSign up for free
Edit

Step 5.2b – Running the Broker Client with the code snippets display

Important! The setup commands for running the Broker Client described in this section include the common commands used for all SCMs. However, some SCMs require additional parameters for the Broker Client setup.

When such additional parameters are required, they are indicated in this section, but when you are setting up a Broker Client for a specific SCM, use also the section that is specific to that SCM. For more information, see Snyk Broker integration setups.

The following explains how to set up the Broker Client in a way that displays code snippets of the Snyk Code results on the Web UI:

Broker Client run with display of code snippets
Broker Client run with display of code snippets

To set up the Broker Client without the code snippets, see Step 5.2a – Running the Broker Client without the code snippet display.

When you are setting up the Broker Client for displaying code snippets, use the same parameters as for the basic Broker Client setup, and add the following file and parameters:

Download a pre-defined accept.json file to your machine. This accept.json file is customized for each SCM, and it contains the required rules for displaying the code snippets.

Add these parameters to the setup commands to mount the accept.json file to the Broker Client:

-e ACCEPT=/<folder_name>/accept.json

-v / local/path/to/<folder_name>:/<folder_name>

Downloading the accept.json file

To display the code snippets of the Snyk Code results on the Web UI, first download a pre-defined accept.json file. When downloading the accept.json file, select the file that is customized for your integrated SCM and save it on an accessible location.

1. Download the accept.json file for your integrated SCM:

On each Integration Setup page, locate the pre-defined accept.json file for this integration, and download it.

2. Verify that the downloaded file is called accept.json. If during the download process the file name has changed, rename the file to its original name.

3. Save the file in a secure and separate folder such as ./private/accept.json.

The next step is running the Broker Client with the accept.json file.

Running the Broker Client with the accept.json file

To run the Broker Client container with the accept.json file, in the terminal, enter the following command to launch a container based on the Snyk Broker Client image:

docker run --restart=always \
   -p <host_machine_port_no._mapped to>:<Broker_Client_container_port_ no.> \
   -e BROKER_TOKEN=<Broker_token> \
   -e <SCM>_TOKEN=<SCM_token> \
   -e <SCM_domain>=<my.SCM.domain.com_(without_http/s)> \  
   -e BROKER_CLIENT_URL=<http://my.broker.client:<host_machine_port_no.> \
   -e PORT=<Broker_Client_container_port_no.> \
   -e GIT_CLIENT_URL=http://<Code_Agent_container_name:Code_Agent_port_no.> \
   -e ACCEPT=/<folder_name>/accept.json \
   -v /local/path/to/<folder_name>:/<folder_name> \
   --network mySnykBrokerNetwork \
   snyk/broker:<SCM_tag>

where:

  • -- restart=always is a Docker command that determines that the Broker Client container will always restart regardless of the exit status.

  • -p <host_machine_port_no._mapped to>:<Broker_Client_container_port_ no.> is the mapping of a physical open port in the host machine to a port in the Broker Client container. These port numbers on the host machine and container do not have to be the same, for example, 8001:8000. The port number of the host machine must be unique.

  • -e BROKER_TOKEN is the Broker token that is associated with the specific Organization and the specific integrated SCM.

  • -e <SCM_TOKEN> is the SCM token for the specific integrated SCM.

  • -e <SCM_domain>= is your SCM domain name without http/https, for example, snyk.git.com. For each SCM,. Use the following parameter:

    • GitHub - the -e <SCM_domain> parameter is NOT required.

    • GitHub Enterprise: -e GITHUB For GitHub Enterprise also add the following parameters: also -e GITHUB_API=<your.ghe.domain.com/api/v3_(without_http/s)> \ -e GITHUB_GRAPHQL=<your.ghe.domain.com/api_(without_http/s)> \

    • Azure Repos: -e AZURE_REPOS_HOST For Azure Repos add the following paramete alsor: -e AZURE_REPOS_ORG=<azure_repo_org_name> \

    • Bitbucket Server/Data Center: -e BITBUCKET For Bitbucket Server/Data Center add the following parameter also: -e BITBUCKET_API=<your.bitbucket-server.domain.com/rest/api/1.0_(without http/s)> \

    • GitLab: -e GITLAB

  • [Optional] -e BROKER_CLIENT_URL= is the URL to the host machine of the Broker Client. The URL can include an IP address or a DNS with the port number of the host machine, for example, http://localhost:8001. Add this parameter only if you are using the same Broker Client for other Snyk products, and you want to enable for them the Automatic PR Checks feature. Since currently the Automatic PR Checks feature is not supported by the Code Agent, you do not have to use this parameter for the Code Agent.

  • -e PORT is the port number of the Broker Client container, where it accepts external connections. The default is 8000. This port number must be the same as the <Broker_Client_container_port_ no.> in the -p parameter above.

  • -e GIT_CLIENT_URL= is a URL to the port of the running Code Agent container. The URL includes the name of the Code Agent container with its port number, for example, http://code-agent:3000.

  • -e ACCEPT= is the name of the folder that stores the downloaded accept.json file with the name of the file, for example, /private/accept.json.

  • -v /local/path/to/<folder_name>:/<folder_name> is the path to the folder that stores the accept.json file with the name of the folder, for example, /private:/private.

  • --network is the name of the Docker bridge network, used for the communication with the Code Agent.

  • snyk/broker:<SCM_tag> is the Docker image of the Broker Client for the specific integrated SCM.

To use the Broker Client with a proxy server, see Setting up the Broker Client to work with a Proxy server.

Once the Broker Client setup is completed successfully, the following message appears in the terminal:

{ ..., "msg":"successfully established a websocket connection to the broker server", ... }

Confirmation message for Broker Client setup
Confirmation message for Broker Client setup

To verify the setup and details of the Broker Client container, **** run:

docker ps

The output is similar to the following:

CONTAINER ID   IMAGE                     COMMAND                  CREATED             STATUS             PORTS                    NAMES
1cef6e3e3290   snyk/broker:github-com    "broker --verbose"       About an hour ago   Up About an hour   0.0.0.0:8000->8000/tcp   nifty_cori  
6216e27b8d28   snyk/code-agent           "docker-entrypoint.s…"   2 hours ago         Up 2 hours         0.0.0.0:3000->3000/tcp   code-agent
PreviousSetting up the Broker Client to work with a proxy serverNextExamples for running the Broker Client with the code snippets display

Last updated

Was this helpful?

#4580: CLI: help, Ignore - support ticket 49463-add Iac examples

Change request updated