File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -18,11 +18,26 @@ Or install it yourself as:
1818
1919 $ gem install quayio-scanner
2020
21+ ## USAGE
22+
23+ This plugin attempts to fetch vulnerabilities for all running containers
24+
25+ ### Parameters
26+
27+ | cli param short | cli param long | help |
28+ | --------------- | -------------------- | ----------------------- |
29+ | -d URL | --docker-url URL | Docker URL |
30+ | -t TOKEN | --quayio-token TOKEN | Quay.io oauth token |
31+ | -w WHITELIST | --whitelist | Vulnerability whitelist |
32+
33+ ### Example
34+
35+ $ check-container-vulnerabilities.rb --docker-url unix:///var/run/docker.sock --quayio-token AccessTokenGoesHere
36+
2137## Contributing
2238
2339Bug reports and pull requests are welcome on GitHub at https://github.com/aboutsource/quayio-scanner .
2440
25-
2641## License
2742
2843The gem is available as open source under the terms of the [ MIT License] ( http://opensource.org/licenses/MIT ) .
@@ -33,4 +48,4 @@ Copyright 2019 - present [Florian Frank](mailto:flori@ping.de) - The gem [json](
3348
3449## Security
3550
36- * [ Snyk] ( https://app.snyk.io/org/about-source/project/6eb2d381-87e7-49c4-a47f-ccad97f33ae3 )
51+ - [ Snyk] ( https://app.snyk.io/org/about-source/project/6eb2d381-87e7-49c4-a47f-ccad97f33ae3 )
Original file line number Diff line number Diff line change 44#
55# DESCRIPTION:
66#
7- # This plugin attempts to fetch vulnerabilties for all running containers
7+ # This plugin attempts to fetch vulnerabilities for all running containers
88#
99# OUTPUT:
1010# plain text
You can’t perform that action at this time.
0 commit comments