# Running your Universal Broker client

Run your Broker deployment on your container engine or Kubernetes cluster.

If you are not using broker.snyk.io, target the Broker server for your region by using the command `-e BROKER_SERVER_URL=https://broker.region.snyk.io \` . For details, see [Broker URLs](https://docs.snyk.io/snyk-data-and-governance/regional-hosting-and-data-residency#broker-server-urls).

Add the environment variable or variables as defined in your credentials references with the associated values. If references are missing, the connection will not be established, and an error entry will be logged in the Broker client logs.

```
docker run --restart=always 
-p 8000:8000 
-e DEPLOYMENT_ID=<DEPLOYMENTID> 
-e CLIENT_ID=<CLIENTID> 
-e CLIENT_SECRET=<CLIENTSECRET> 
-e PORT=8000 
-e <YOUR_CREDENTIALS_REFERENCE>=<secret value> 
snyk/broker:universal
```

A [Helm chart](https://github.com/snyk/snyk-universal-broker-helm) is available for use on Kubernetes clusters. Refer to the readme for details.

Ensure that you first pull the Helm chart:

`helm pull oci://registry-1.docker.io/snyk/snyk-universal-broker`

Then run:

```
helm install my-snyk-broker oci://registry-1.docker.io/snyk/snyk-universal-broker \
  --set deploymentId='YOUR_DEPLOYMENT_ID' \
  --set clientId='YOUR_CLIENT_ID' \
  --set clientSecret='YOUR_CLIENT_SECRET' \
  --set credentialReferences.MY_GITHUB_TOKEN='YOUR_GITHUB_PAT' \
```

#### Secret Values

Integration types may require different SCM-specific authentication parameters. When setting your credential reference environment variable in your Broker deployment you may wish to consult the following list of secret values and their required formats:

| Integration Type   | Parameter Name                             | Format                                                           |
| ------------------ | ------------------------------------------ | ---------------------------------------------------------------- |
| Artifactory        | Artifactory URL                            | `<username>:<password>@<yourdomain.artifactory.com>/artifactory` |
| Azure Repos        | Azure Repos Token                          | Azure Repos PAT                                                  |
| Bitbucket Server   | Bitbucket Password                         | Alphanumeric password                                            |
|                    | Bitbucket PAT                              | Bitbucket Personal Access Token                                  |
| Container Registry | Azure CR Password                          | Alphanumeric password                                            |
|                    | Artifactory CR Password (ACR)              | Alphanumeric password                                            |
|                    | Docker Hub Password                        | Alphanumeric password                                            |
|                    | DigitalOcean CR Token                      | DigitalOcean PAT                                                 |
|                    | Amazon Elastic Container CR Role ARN (ECR) | AWS IAM role ARN                                                 |
|                    | Google Cloud Container (GCR) Password      | Alphanumeric password                                            |
|                    | GitHub CR Password                         | Alphanumeric password                                            |
|                    | GitLab CR Password                         | Alphanumeric password                                            |
|                    | Google Artifact CR Password                | Alphanumeric password                                            |
|                    | Harbor CR Password                         | Alphanumeric password                                            |
|                    | Nexus CR Password                          | Alphanumeric password                                            |
|                    | Quay CR Password                           | Alphanumeric password                                            |
| Github             | Github Token                               | Github Personal Access Token                                     |
| Github Enterprise  | Github Token                               | Github Personal Access Token                                     |
| Github Server App  | Github App Client ID                       | Github App Client ID                                             |
| Github Cloud App   | Github App Client ID                       | Github App Client ID                                             |
| Gitlab             | Gitlab Token                               | Gitlab Personal Access Token                                     |
| Jira               | Jira Password                              | Alphanumeric password                                            |
|                    | Jira PAT                                   | JIRA Personal Access Token                                       |
| Nexus              | Nexus Base URL                             | `https://<username>:<password>@<your.nexus.hostname>`            |