mirror of
https://gitea.com/mcereda/oam.git
synced 2026-02-08 21:34:25 +00:00
chore(kics): add config example
This commit is contained in:
6
examples/kics.config
Normal file
6
examples/kics.config
Normal file
@@ -0,0 +1,6 @@
|
||||
---
|
||||
exclude-paths:
|
||||
# The container starts in '/app/bin', these paths are relative to there.
|
||||
# See the command in the lefthook configuration.
|
||||
- repository/container-images/image-builder
|
||||
exclude-severities: info,low
|
||||
@@ -6,10 +6,19 @@
|
||||
## TL;DR
|
||||
|
||||
<details>
|
||||
<summary>Installation and configuration</summary>
|
||||
<summary>Setup</summary>
|
||||
|
||||
```sh
|
||||
docker pull 'checkmarx/kics'
|
||||
|
||||
cat <<EOF > kics.config
|
||||
---
|
||||
exclude-paths:
|
||||
# The container starts in '/app/bin', these paths are relative to there.
|
||||
# See the command in the lefthook configuration.
|
||||
- repository/container-images/image-builder
|
||||
exclude-severities: info,low
|
||||
EOF
|
||||
```
|
||||
|
||||
</details>
|
||||
@@ -18,8 +27,9 @@ docker pull 'checkmarx/kics'
|
||||
<summary>Usage</summary>
|
||||
|
||||
```sh
|
||||
docker run -t -v "${PWD}:/path" 'checkmarx/kics' scan -p '/path'
|
||||
docker run -t -v "${PWD}:/path" 'checkmarx/kics' scan -p '/path' -o '/path/'
|
||||
docker run -t -v "${PWD}:/workdir" 'checkmarx/kics' scan -p '/workdir'
|
||||
docker run -t -v "${PWD}:/workdir" 'checkmarx/kics' \
|
||||
scan -p '/workdir' -o '/workdir/output' --report-formats "glsast,html,pdf" --output-name kics-result
|
||||
```
|
||||
|
||||
</details>
|
||||
@@ -33,6 +43,7 @@ docker run -t -v "${PWD}:/path" 'checkmarx/kics' scan -p '/path' -o '/path/'
|
||||
## Further readings
|
||||
|
||||
- [Website]
|
||||
- [Codebase]
|
||||
|
||||
<!--
|
||||
Reference
|
||||
@@ -43,6 +54,7 @@ docker run -t -v "${PWD}:/path" 'checkmarx/kics' scan -p '/path' -o '/path/'
|
||||
<!-- Knowledge base -->
|
||||
<!-- Files -->
|
||||
<!-- Upstream -->
|
||||
[website]: https://docs.kics.io/latest/
|
||||
[Codebase]: https://github.com/Checkmarx/kics/
|
||||
[Website]: https://docs.kics.io/latest/
|
||||
|
||||
<!-- Others -->
|
||||
|
||||
Reference in New Issue
Block a user