Skip to content

Commit 95b96be

Browse files
awileysnykgitbook-bot
authored andcommitted
GITBOOK-9162: Broker: Derived Docker images to Custom Docker images, title and headings
1 parent 395320f commit 95b96be

File tree

12 files changed

+24
-24
lines changed

12 files changed

+24
-24
lines changed

docs/SUMMARY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@
144144
* [Jira - install and configure using Docker](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md)
145145
* [Jira - install and configure using Helm](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/jira-install-and-configure-using-helm.md)
146146
* [Jira - environment variables for Snyk Broker](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/jira-environment-variables-for-snyk-broker.md)
147-
* [Derived Docker images for Broker Client integrations and Container Registry Agent](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md)
147+
* [Custom Docker images for Broker Client integrations and Container Registry Agent](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md)
148148
* [Advanced configuration for Snyk Broker Docker installation](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation/README.md)
149149
* [Changing the auth method with Docker](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation/changing-the-auth-method-with-docker.md)
150150
* [Credential pooling with Docker and Helm](enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/advanced-configuration-for-snyk-broker-docker-installation/credential-pooling-with-docker-and-helm.md)

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ docker run --restart=always \
4545
snyk/broker:artifactory
4646
```
4747

48-
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the Artifactory integration.
48+
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the Artifactory integration.
4949

5050
## Start the Broker Client container and verify the connection with Artifactory Repository
5151

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/azure-repos-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-azure-repos.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ docker run --restart=always \
4343
snyk/broker:azure-repos
4444
```
4545

46-
As an **alternative to using the Docker run command,** you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the Azure Repos integration.
46+
As an **alternative to using the Docker run command,** you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the Azure Repos integration.
4747

4848
## Start the Broker Client container and verify the connection with Azure Repos
4949

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/data-center.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ docker run --restart=always \
4444
Snyk Essentials is set by default to **`false`**. Enable it by setting the flag to **`true`**.
4545
{% endhint %}
4646

47-
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the BitBucket Server/Data Center integration.
47+
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the BitBucket Server/Data Center integration.
4848

4949
## Configure Broker to be used with Bitbucket using a Personal Access Token (PAT)
5050

@@ -77,7 +77,7 @@ docker run --restart=always \
7777
Snyk Essentials is set by default to **`false`**. Enable it by setting the flag to **`true`**.
7878
{% endhint %}
7979

80-
As an alternative to using the Docker run command, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the BitBucket Server/Data Center integration.
80+
As an alternative to using the Docker run command, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the BitBucket Server/Data Center integration.
8181

8282
## Start the Broker Client container and verify the connection with Bitbucket
8383

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Derived Docker images for Broker Client integrations and Container Registry Agent
1+
# Custom Docker images for Broker Client integrations and Container Registry Agent
22

33
{% hint style="info" %}
4-
Using the information on this page is not required to set up Broker Client integrations. You may use a derived Docker image to set up a Broker Client integration. This is an alternative to running the command explained in the instructions for setting up each integration.
4+
Using the information on this page is not required to set up Broker Client integrations. You may use a custom Docker image to set up a Broker Client integration. This is an alternative to running the command explained in the instructions for setting up each integration.
55
{% endhint %}
66

7-
## Derived Docker image for Azure Repos Broker integration setup
7+
## Custom Docker image for Azure Repos Broker integration setup
88

99
As an alternative to using the Docker run command shown on the [setup page](azure-repos-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-azure-repos.md), you can build your own Docker image and override relevant environment variables:
1010

@@ -19,7 +19,7 @@ ENV BROKER_CLIENT_URL http://my.broker.client:8000
1919
ENV PORT 8000
2020
```
2121

22-
## Derived Docker image for Bitbucket Server/Data Center Broker integration setup
22+
## Custom Docker image for Bitbucket Server/Data Center Broker integration setup
2323

2424
As an alternative to using the Docker run command shown on the [setup page](bitbucket-server-data-center-prerequisites-and-steps-to-install-and-configure-broker/data-center.md), you can build your own Docker image and override relevant environment variables:
2525

@@ -34,7 +34,7 @@ ENV BITBUCKET_API your.bitbucket-server.domain.com/rest/api/1.0
3434
ENV PORT 8000
3535
```
3636

37-
## Derived Docker image for GitHub Broker integration setup
37+
## Custom Docker image for GitHub Broker integration setup
3838

3939
As an alternative to using the Docker run command shown on the [setup page](github-prerequisites-and-steps-to-install-and-configure-broker/github-install-and-configure-using-docker.md), you can build your own Docker image and override relevant environment variables:
4040

@@ -47,7 +47,7 @@ ENV PORT 8000
4747
ENV BROKER_CLIENT_URL http://my.broker.client:8000
4848
```
4949

50-
## Derived Docker image for GitHub Enterprise Broker integration setup
50+
## Custom Docker image for GitHub Enterprise Broker integration setup
5151

5252
As an alternative to using the Docker run command shown on the [setup page](github-enterprise-prerequisites-and-steps-to-install-and-configure-broker/github-enterprise-install-and-configure-using-docker.md), you can build you own Docker image and override relevant environment variables:
5353

@@ -63,7 +63,7 @@ ENV PORT 8000
6363
ENV BROKER_CLIENT_URL http://my.broker.client:8000
6464
```
6565

66-
## Derived Docker image for GitLab Broker integration setup
66+
## Custom Docker image for GitLab Broker integration setup
6767

6868
As an alternative to using the Docker run command shown on the [setup page](gitlab-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-gitlab.md), you can build your own Docker image and override relevant environment variables:
6969

@@ -77,7 +77,7 @@ ENV BROKER_CLIENT_URL http://my.broker.client:8000
7777
ENV PORT 8000
7878
```
7979

80-
## Derived Docker image for Jira Broker integration setup
80+
## Custom Docker image for Jira Broker integration setup
8181

8282
As an alternative to using the Docker run command shown on the [setup page](jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md), you can build your own Docker image and override relevant environment variables:
8383

@@ -91,7 +91,7 @@ ENV JIRA_HOSTNAME your.jira.domain.com
9191
ENV PORT 8000
9292
```
9393

94-
## Derived Docker image for Artifactory Broker integration setup
94+
## Custom Docker image for Artifactory Broker integration setup
9595

9696
As an alternative to using the Docker run command shown on the [setup page](artifactory-repository-install-and-configure-broker/set-up-snyk-broker-with-artifactory-repository.md), you can build your own Docker image and override relevant environment variables:
9797

@@ -102,7 +102,7 @@ ENV BROKER_TOKEN secret-broker-token
102102
ENV ARTIFACTORY_URL <yourdomain>.artifactory.com
103103
```
104104

105-
## Derived Docker image for Nexus 3 Broker integration setup
105+
## Custom Docker image for Nexus 3 Broker integration setup
106106

107107
As an alternative to using the Docker run command shown on the [setup page](nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md), you can build your own Docker image and override relevant environment variables:
108108

@@ -120,7 +120,7 @@ ENV RES_BODY_URL_SUB https://<your.nexus.hostname>/repository
120120
By default for Nexus 3, the X-Forwarded-For headers are stripped off by the Broker Client so Nexus returns the npm tarball uri to the Nexus Registry instead of the Broker Server. Include the environment variable `REMOVE_X_FORWARDED_HEADERS=false` to disable this behavior.
121121
{% endhint %}
122122

123-
## Derived Docker image for Nexus 2 Broker integration setup
123+
## Custom Docker image for Nexus 2 Broker integration setup
124124

125125
As an alternative to using the Docker run command shown on the [setup page](nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md), you can build your own Docker image and override relevant environment variables:
126126

@@ -137,7 +137,7 @@ ENV RES_BODY_URL_SUB https://<your.nexus.hostname>/nexus/content
137137
By default for Nexus 2, the X-Forwarded-For headers are stripped off by the Broker Client so Nexus returns the npm tarball uri to the Nexus Registry instead of the Broker Server. Include the environment variable REMOVE\_X\_FORWARDED\_HEADERS=false to disable this behavior.
138138
{% endhint %}
139139

140-
## Derived Docker image for Container Registry Agent setup
140+
## Custom Docker image for Container Registry Agent setup
141141

142142
As an alternative to using the Docker run command shown on the [setup page](../../snyk-broker-container-registry-agent/), you can build your own Docker image and override relevant environment variables:
143143

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/github-enterprise-prerequisites-and-steps-to-install-and-configure-broker/github-enterprise-install-and-configure-using-docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ docker run --restart=always \
4040
Snyk Essentials is set by default to **`false`**. Enable it by setting the flag to **`true`**.
4141
{% endhint %}
4242

43-
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the GitHub Enterprise integration.
43+
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the GitHub Enterprise integration.
4444

4545
## Start the Broker Client container and verify the connection with GitHub Enterprise
4646

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/github-prerequisites-and-steps-to-install-and-configure-broker/github-install-and-configure-using-docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ docker run --restart=always \
3737
Snyk Essentials is set by default to **`false`**. Enable it by setting the flag to **`true`**.
3838
{% endhint %}
3939

40-
As an **alternative using to the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the GitHub integration.
40+
As an **alternative using to the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the GitHub integration.
4141

4242
## Start the Broker Client container and verify the connection with GitHub
4343

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/gitlab-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-gitlab.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Use the environment variable `REMOVE_X_FORWARDED_HEADERS=true` to remove the `XF
3838

3939
Snyk Essentials is set by default to `false`. Enable it by setting the flag to `true`.
4040

41-
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the GitLab integration.
41+
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the GitLab integration.
4242

4343
## Start the Broker Client container and verify the connection with GitLab
4444

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/install-and-configure-broker-using-docker.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ The following pages explain how to install these special integrations.
2828
* [Nexus Repository Manager](nexus-repository-prerequisites-and-steps-to-install-and-configure-broker/set-up-snyk-broker-with-nexus-repository-manager.md)
2929
* [Jira](jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md)
3030
* [Snyk Broker - Container Registry Agent](../../snyk-broker-container-registry-agent/) (needed to connect to Container Registries)
31-
* [Derived Docker images for Broker Client integrations and Container Registry Agent](derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md)
31+
* [Derived Docker images for Broker Client integrations and Container Registry Agent](custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md)
3232

3333
You can customize the configuration using the environment variables in the Docker images. For this reason, install separate, multiple instances of the Broker Client for different integration types to ensure proper configuration as well as redundancy.
3434

docs/enterprise-setup/snyk-broker/classic-broker/install-and-configure-snyk-broker/jira-prerequisites-and-steps-to-install-and-configure-broker/setup-broker-with-jira.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ docker run --restart=always \
3232

3333
If necessary, navigate to [Advanced configuration for Snyk Broker Docker installation](../advanced-configuration-for-snyk-broker-docker-installation/) and make any configuration changes needed, for example, providing the CA (Certificate Authority) to the Broker Client configuration when the Jira instance is using a private certificate.
3434

35-
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../derived-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the Jira integration.
35+
As an **alternative to using the Docker run command**, you can use a derived Docker image to set up the Broker Client integration. See [Derived Docker images](../custom-docker-images-for-broker-client-integrations-and-container-registry-agent.md) for the environment variables to override for the Jira integration.
3636

3737
## Jira PAT authentication for SSO-enabled JIRA
3838

0 commit comments

Comments
 (0)