README

Signed-off-by: Rahul Jadhav <[email protected]>
accuknox · Apr 28, 2024 · 419f34c · 419f34c
1 parent e1fa316
commit 419f34c
Showing 1 changed file with 10 additions and 3 deletions.
diff --git a/sast-job/README.md b/sast-job/README.md
@@ -1,15 +1,22 @@
 # 
 
 ```
-docker run --rm -it -e SQ_URL=http://35.188.10.229:9000 -e SQ_AUTH_TOKEN=<AUTH-TOKEN> -e SQ_PROJECTS="^nimbus$" -e REPORT_PATH=/app/data/ -v $PWD:/app/data/ accuknox/sastjob:latest
+docker run --rm -it \
+	-e SQ_URL=http://35.188.10.229:9000 \
+	-e SQ_AUTH_TOKEN=<AUTH-TOKEN> \
+	-e SQ_PROJECTS="^nimbus$" \
+	-e REPORT_PATH=/app/data/ \
+	-v $PWD:/app/data/ \
+	accuknox/sastjob:latest
 ```
 
-Configuration
+## Configuration
+
 |      Var       | Sample Value              | Description                        |
 |----------------|---------------------------|------------------------------------|
 | SQ_URL*        | http://35.188.10.229:9000 | SonarQube server URL               |
 | SQ_AUTH_TOKEN* | squ_token                 | SonarQube user authn token         |
 | SQ_PROJECTS    | "^nimbus$"                | Scan the given projects/components |
 | REPORT_PATH    | /app/data/                | Path to keep the report json files |
 
-> * are mandatory configuration options
+> variables marked with '*' are mandatory configuration options