Skip to content

Commit

Permalink
docs: update container registry agent environment variables
Browse files Browse the repository at this point in the history
  • Loading branch information
ahmed-agabani-snyk committed Aug 6, 2021
1 parent e9801ea commit 4824559
Showing 1 changed file with 13 additions and 3 deletions.
16 changes: 13 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -311,7 +311,11 @@ are mandatory to configure the Broker client:
- `BROKER_TOKEN` - The Snyk Broker token, obtained from your Container registry integration settings (app.snyk.io).
- `BROKER_CLIENT_URL` - The URL of your broker client (including scheme and - port) used by container registry agent to call back to Snyk.
- `CR_AGENT_URL` - The URL of your container registry agent (including scheme and - port) to which brokered requests would be forwarded.
- `CR_CREDENTIALS` - Base64-encoded credentials json used by agent to access container registry.
- `CR_TYPE` - The container registry type as listed in supporter registries, for example "DockerHub", "GoogleCR", "ArtifactoryCR".
- `CR_BASE` - The hostname of the container registry api to connect to, for example: "cr.host.com".
- `CR_USERNAME` - The username for authenticating to container registry api. Not used for DigitalOcean container registry.
- `CR_PASSWORD` - The password for authenticating to container registry api. Not used for DigitalOcean container registry.
- `CR_TOKEN` - Authentication token for DigitalOcean container registry.
- `PORT` - The local port at which the Broker client accepts connections. Default is 7341.

#### Command-line arguments
Expand All @@ -324,7 +328,10 @@ docker run --restart=always \
-e BROKER_TOKEN=secret-broker-token \
-e BROKER_CLIENT_URL=https://my.broker.client:8000 \
-e CR_AGENT_URL=https://my.container.registry.agent \
-e CR_CREDENTIALS=base64-encoded-credentials-json \
-e CR_TYPE=container-registry-type \
-e CR_BASE=your.container.registry.domain.com \
-e CR_USERNAME=secret-container-registry-username \
-e CR_PASSWORD=secret-container-registry-password \
-e PORT=8000 \
snyk/broker:container-registry-agent
```
Expand All @@ -339,7 +346,10 @@ FROM snyk/broker:container-registry-agent
ENV BROKER_TOKEN secret-broker-token
ENV BROKER_CLIENT_URL https://my.broker.client:8000
ENV CR_AGENT_URL https://my.container.registry.agent
ENV CR_CREDENTIALS base64-encoded-credentials-json
ENV CR_TYPE container-registry-type
ENV CR_BASE your.container.registry.domain.com
ENV CR_USERNAME secret-container-registry-username
ENV CR_PASSWORD secret-container-registry-password
ENV PORT 8000
```

Expand Down

0 comments on commit 4824559

Please sign in to comment.