diff --git a/docs/enterprise-setup/snyk-broker/universal-broker/initial-configuration-of-the-universal-broker.md b/docs/enterprise-setup/snyk-broker/universal-broker/initial-configuration-of-the-universal-broker.md index 07901b6352f9..dd620d8aed9a 100644 --- a/docs/enterprise-setup/snyk-broker/universal-broker/initial-configuration-of-the-universal-broker.md +++ b/docs/enterprise-setup/snyk-broker/universal-broker/initial-configuration-of-the-universal-broker.md @@ -21,7 +21,7 @@ To use this command, you must install Node 18 or higher. 1. Run `npm i -g snyk-broker-config`. 2. Set the necessary environment variables: * `SNYK_TOKEN` if not already set. This must be your personal API key. - * `SNYK_API_HOSTNAME` if not targeting https://api.snyk.io, for example,`export SNYK_API_HOSTNAME=https://api.eu.snyk.io` + * `SNYK_API_HOSTNAME` if you are not targeting https://api.snyk.io, for example,`export SNYK_API_HOSTNAME=https://api.eu.snyk.io` 3. Ensure that as you follow the remaining steps, you set more environment variables as needed to ensure the experience proceeds smoothly, for example: * `TENANT_ID` so you do not have to enter it on every command * `INSTALL_ID` if you have one, otherwise the tool will walk you through the installation process @@ -34,10 +34,10 @@ To use this command, you must install Node 18 or higher. * **Optional**: When the workflow deployment has been created, view your deployment using `snyk-broker-config workflows deployments get`. 7. Create and configure your connection or connections. * Run `snyk-broker-config workflows connections create` to create a connection. - * In response to the prompt **Which Deployment do you want to use?,** select your deployment from the list presented. - * In response to the prompt **Which Connection type do you want to create?** + * In response to the prompt **Which Deployment do you want to use?**, select your deployment from the list presented. + * In response to the prompt **Which Connection type do you want to create?**: * Select the type of connection you want to create from the list presented.\ - Options include SCM connection types like `github` and variants, `bitbucket` and variants, `gitlab` and `azure`, as well as container registry connections (see the next step), package manager connections, Jira, and more. + Options include SCM connection types like `github` and variants, `bitbucket` and variants, `gitlab`, and `azure`, as well as container registry connections (see the next step), package manager connections, Jira, and more. * For container registry-type Broker connections, specify a CR\_AGENT\_URL, which will point to a Container Registry Agent.\ You must configure and run both the Universal Broker and a separate Container Registry Agent. Follow the instructions for [configuring and running a Container Registry Agent](../snyk-broker-container-registry-agent/#configuring-and-running-the-container-registry-agent). * Provide the configuration for each required field in response to the prompts: @@ -45,7 +45,7 @@ To use this command, you must install Node 18 or higher. * Enter the **broker\_client-url** (the hostname and port of your Broker client, for example, https://my.broker.company.com:8000). * Enter the credential reference or choose the option **CreateNew** in response to a prompt like **github-token (Sensitive): Which Credential Reference do you want to use? Or create New?** * When you see the messages **Connection created** and **Ready to configure integrations to use this connection**, you can run the Broker client. -8. After the connection is created, use `snyk-broker-config workflows connections integrate` to configure an integration to use the newly created connection. In response to the prompts, enter the **deployment** you want to use, the **connection** you want to use, the **OrgID** of the Organization you want to integrate, and the `integration ID` of the type `github`. You can find your `integration ID` in your Organization **Integrations** settings, or retrieve it using the [Integrations](../../../snyk-api/reference/integrations-v1.md) API. +8. After the connection is created, use `snyk-broker-config workflows connections integrate` to configure an integration to use the newly created connection. In response to the prompts, enter the **deployment** you want to use, the **connection** you want to use, the **OrgID** of the Organization you want to integrate, and the `integration ID` of the type `github`. You can find your `integration ID` in your Organization **Integrations** settings or retrieve it using the [Integrations](../../../snyk-api/reference/integrations-v1.md) API. ## Example: first-time configuration of a new connection