snyk-broker 4.128.0 → 4.129.2

package/README.md

@@ -261,6 +261,42 @@ ENV BROKER_TOKEN      secret-broker-token
 ENV ARTIFACTORY_URL   <yourdomain>.artifactory.com
 ```
 
+### Nexus 3
+
+To use the Nexus 3 client with an Nexus 3 deployment, run `docker pull snyk/broker:nexus` tag. The following environment variables are needed to customize the Broker client:
+
+- `BROKER_TOKEN` - the snyk broker token, obtained from your artifactory integration settings view.
+- `BASE_NEXUS_URL` - the URL of your Nexus 3 deployment, such as `https://[<user>:<pass>@]<your.nexus.hostname>`.
+- `BROKER_CLIENT_VALIDATION_URL` - Nexus validation url, checked by broker client systemcheck endpoint. If Nexus user requires auth, use `$BASE_NEXUS_URL/service/rest/v1/status/check` (e.g. `https://<user>:<pass>@<your.nexus.hostname>/service/rest/v1/status/check`) otherwise use `$BASE_NEXUS_URL/service/rest/v1/status` (e.g. `https://<your.nexus.hostname>/service/rest/v1/status`).
+- (Optional) `RES_BODY_URL_SUB` - This URL substitution is required for NPM/Yarn integration and is the same as the URL of the Nexus without credentials appended with `/repository`, e.g. `https://<your.nexus.hostname>/repository`
+
+#### Command-line arguments
+
+You can run the docker container by providing the relevant configuration:
+
+```console
+docker run --restart=always \
+           -p 7341:7341 \
+           -e BROKER_TOKEN=secret-broker-token \
+           -e BASE_NEXUS_URL=https://[<user>:<pass>@]<your.nexus.hostname> \
+           -e BROKER_CLIENT_VALIDATION_URL=https://<your.nexus.hostname>/service/rest/v1/status[/check] \
+           -e RES_BODY_URL_SUB=https://<your.nexus.hostname>/repository \
+       snyk/broker:nexus
+```
+
+#### Derived docker image
+
+Another option is to build your own docker image and override relevant environment variables:
+
+```dockerfile
+FROM snyk/broker:nexus
+
+ENV BROKER_TOKEN                     secret-broker-token
+ENV BASE_NEXUS_URL                   https://[<user>:<pass>@]<your.nexus.hostname>
+ENV BROKER_CLIENT_VALIDATION_URL     https://<your.nexus.hostname>/service/rest/v1/status[/check]
+ENV RES_BODY_URL_SUB                 https://<your.nexus.hostname>/repository
+```
+
 ### Jira
 
 To use the Broker client with a Jira deployment, run `docker pull snyk/broker:jira` tag. The following environment variables are mandatory to configure the Broker client:

package/dist/client-templates/nexus2/.env.sample

@@ -22,6 +22,8 @@ BROKER_HEALTHCHECK_PATH=/healthcheck
 # This URL substitution is required for NPM integration
 # RES_BODY_URL_SUB=https://<your.nexus.hostname>/nexus/content
 
+# Nexus validation url, checked by broker client systemcheck endpoint
+# works with / without auth
 BROKER_CLIENT_VALIDATION_URL=$BASE_NEXUS_URL/nexus/service/local/status
 
 BROKER_CLIENT_VALIDATION_JSON_DISABLED=true

package/dist/package.json

@@ -88,5 +88,5 @@
     },
     "homepage": "https://github.com/snyk/broker#readme",
     "snyk": true,
-    "version": "4.128.0"
+    "version": "4.129.2"
 }

package/dist/tsconfig.tsbuildinfo

@@ -472,7 +472,7 @@
         "affectsGlobalScope": true
       },
       "../package.json": {
-        "version": "893510d9bf5d178a425edbb6f7bb01e181cb7143795ae7f6a6f52f46bc565392",
+        "version": "17d1edc56dac0c5c4148d2b257db4bb82c788db27c8818134023b4367d2bab6a",
         "signature": "4b7aff601ec65d9674146cc6cb2de0e47e8d203c86a24ccb3d43fbf25afffb24",
         "affectsGlobalScope": true
       },
@@ -567,8 +567,8 @@
         "affectsGlobalScope": true
       },
       "../node_modules/@babel/types/lib/index.d.ts": {
-        "version": "67633388f50fe010a7b4d892721437d0fac88a282ef46217137d263a8a6651ed",
-        "signature": "67633388f50fe010a7b4d892721437d0fac88a282ef46217137d263a8a6651ed",
+        "version": "ef178bff7cb17db8a2f3535f947f54cf6c22de8f87f9727cb340754c56c212ec",
+        "signature": "ef178bff7cb17db8a2f3535f947f54cf6c22de8f87f9727cb340754c56c212ec",
         "affectsGlobalScope": false
       },
       "../node_modules/@types/babel__generator/index.d.ts": {
@@ -587,8 +587,8 @@
         "affectsGlobalScope": false
       },
       "../node_modules/@types/babel__traverse/ts4.1/index.d.ts": {
-        "version": "7ec562d20173996ab057cd17eb0af2e5de5fee1b1024ef20373c105b18020346",
-        "signature": "7ec562d20173996ab057cd17eb0af2e5de5fee1b1024ef20373c105b18020346",
+        "version": "4dd55fea4ad11246df875a5fd4663382ed4dd0002d0a0ea77901399e3b678065",
+        "signature": "4dd55fea4ad11246df875a5fd4663382ed4dd0002d0a0ea77901399e3b678065",
         "affectsGlobalScope": false
       },
       "../node_modules/@types/babel__core/index.d.ts": {

package/package.json

@@ -88,5 +88,5 @@
   },
   "homepage": "https://github.com/snyk/broker#readme",
   "snyk": true,
-  "version": "4.128.0"
+  "version": "4.129.2"
 }