Skip to content

Commit b8fbb2a

Browse files
committed
README: Update for DinD CI-MODE
Update the README to be able the launch Vulnscout in CI mode in a DinD scenario
1 parent 112eba6 commit b8fbb2a

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Support for Cyclone DX, SPDX, Yocto JSON files, and Open VEX.
66

77
## Requirements
88

9-
The command `docker-compose` or `docker compose` should be available on the host device.
9+
The command `docker-compose` or `docker compose` and `docker` should be available on the host device.
1010

1111
## Installation
1212

@@ -105,7 +105,7 @@ Using a Docker container to build the project requires additional configuration
105105

106106
Indeed, the web interface won't be mapped to the host if the building Docker container is not properly configured.
107107

108-
CQFD requires adding `docker-compose-v2` to your *.cfqd/docker/Dockerfile* and exporting the following variable:
108+
CQFD requires adding `docker-compose-v2` to the package installed in your *.cfqd/docker/Dockerfile* and exporting the following variable:
109109

110110
``` bash
111111
export CQFD_EXTRA_RUN_ARGS="-v /run/docker.sock:/run/docker.sock"
@@ -128,6 +128,24 @@ cqfd run ./build.sh -- bitbake <your_Yocto_image> -c vulnscout
128128
If the container can't be configured (e.g., with kas-container).
129129
Vulnscout web interface can still be run directly on the host with the ' docker-compose` command.
130130

131+
### Using CI Mode with a building Docker container
132+
To be able to launch VulnScout in the CI mode with a building Docker container, you need to add the following lines:
133+
``` bash
134+
ENV BB_ENV_PASSTHROUGH="VULS_FAIL_CONDITION"
135+
ENV VULS_FAIL_CONDITION="<your_condition>"
136+
```
137+
in your *.cfqd/docker/Dockerfile*. As mentioned, you need to use this environment variable for the CI mode.
138+
139+
To launch VulnScout in CI:
140+
141+
**If you use CQFD and KAS**
142+
``` bash
143+
cqfd kas shell -c "bitbake -c <your_Yocto_image> -c vulnscout_ci"
144+
```
145+
**If you use CQFD and the script build.sh made by Savoir-Faire Linux**
146+
```bash
147+
cqfd run ./build.sh -- bitbake <your_Yocto_image> -c vulnscout_ci
148+
```
131149
## Result
132150

133151
![Screenshot](doc/vulnscout-ui.png)

0 commit comments

Comments
 (0)