mirror of
https://github.com/gocsaf/csaf.git
synced 2025-12-22 11:55:40 +01:00
Improve docs for checker and downloader
* make it more clear that a domain can also be interpreted as a direct URL. resolve #316 --------- Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com> Co-authored-by: Sascha L. Teichmann <sascha.teichmann@intevation.de> Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
This commit is contained in:
parent
05ad714619
commit
39b48e083c
3 changed files with 12 additions and 3 deletions
|
|
@ -162,7 +162,7 @@ func buildReporters() []reporter {
|
|||
}
|
||||
}
|
||||
|
||||
// run uses a processor to check all the given domains
|
||||
// run uses a processor to check all the given domains or direct urls
|
||||
// and generates a report.
|
||||
func run(opts *options, domains []string) (*Report, error) {
|
||||
p, err := newProcessor(opts)
|
||||
|
|
@ -189,7 +189,7 @@ func main() {
|
|||
errCheck(opts.prepare())
|
||||
|
||||
if len(domains) == 0 {
|
||||
log.Println("No domains given.")
|
||||
log.Println("No domain or direct url given.")
|
||||
return
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -26,6 +26,11 @@ Help Options:
|
|||
-h, --help Show this help message
|
||||
```
|
||||
|
||||
Will check all given _domains_, by trying each as a CSAF provider.
|
||||
|
||||
If a _domain_ starts with `https://` it is instead considered a direct URL to the `provider-metadata.json` and checking procedes from there.
|
||||
|
||||
|
||||
Usage example:
|
||||
` ./csaf_checker example.com -f html --rate=5.3 -H apikey:SECRET -o check-results.html`
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
## csaf_downloader
|
||||
A tool to download CSAF content from a specific domain/provider.
|
||||
A tool to download CSAF documents from CSAF providers.
|
||||
|
||||
### Usage
|
||||
|
||||
|
|
@ -20,3 +20,7 @@ Application Options:
|
|||
Help Options:
|
||||
-h, --help Show this help message
|
||||
```
|
||||
|
||||
Will download all CSAF documents for the given _domains_, by trying each as a CSAF provider.
|
||||
|
||||
If a _domain_ starts with `https://` it is instead considered a direct URL to the `provider-metadata.json` and downloading procedes from there.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue