Skip to content

Commit

Permalink
docs: Update CR_AGENT_URL env variable docs
Browse files Browse the repository at this point in the history
  • Loading branch information
snaftaly committed Jan 19, 2021
1 parent edc6e65 commit 923a540
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -299,7 +299,7 @@ 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 hostname of your container registry agent.
- `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.
- `PORT` - The local port at which the Broker client accepts connections. Default is 7341.

Expand All @@ -312,7 +312,7 @@ docker run --restart=always \
-p 8000:8000 \
-e BROKER_TOKEN=secret-broker-token \
-e BROKER_CLIENT_URL=http://my.broker.client:8000 \
-e CR_AGENT_URL=agent-url \
-e CR_AGENT_URL=http://my.container.registry.agent \
-e CR_CREDENTIALS=base64-encoded-credentials-json \
-e PORT=8000 \
snyk/broker:container-registry-agent
Expand All @@ -327,7 +327,7 @@ FROM snyk/broker:container-registry-agent

ENV BROKER_TOKEN secret-broker-token
ENV BROKER_CLIENT_URL http://my.broker.client:8000
ENV CR_AGENT_URL agent-hostname
ENV CR_AGENT_URL http://my.container.registry.agent
ENV CR_CREDENTIALS base64-encoded-credentials-json
ENV PORT 8000
```
Expand Down
2 changes: 1 addition & 1 deletion client-templates/container-registry-agent/.env.sample
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ BROKER_HEALTHCHECK_PATH=/healthcheck
BROKER_CLIENT_URL="https://<broker-client-host>:<broker-client-port>"

# The URL of your container registry agent
CR_AGENT_URL=<agent-host>:<agent-port>
CR_AGENT_URL="https://<agent-host>:<agent-port>"

# Base64-encoded credentials json used to access container registry via agent
CR_CREDENTIALS=<base64-encoded-credentials-json>
Expand Down

0 comments on commit 923a540

Please sign in to comment.