diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/installation.md | 2 | ||||
| -rw-r--r-- | docs/quickstart.md | 4 | ||||
| -rw-r--r-- | docs/user_guide.md | 6 |
3 files changed, 6 insertions, 6 deletions
diff --git a/docs/installation.md b/docs/installation.md index d489b03c..6a33ec22 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -34,7 +34,7 @@ pip install -e . python -m spacy download en_core_web_sm ``` -Alternatively, our Our [Dockerfile](https://github.com/crocs-muni/sec-certs/blob/main/Dockerfile) represents a reproducible way of setting up the environment. +Alternatively, our [Dockerfile](https://github.com/crocs-muni/sec-certs/blob/main/Dockerfile) represents a reproducible way of setting up the environment. ::: :::: diff --git a/docs/quickstart.md b/docs/quickstart.md index 8371163f..039db94b 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -10,7 +10,7 @@ from sec_certs.dataset.cc import CCDataset dset = CCDataset.from_web() ``` -to obtain to obtain freshly processed dataset from [sec-certs.org](https://sec-certs.org). +to obtain the freshly processed dataset from [sec-certs.org](https://sec-certs.org). 3. Play with the dataset. See [example notebook](./notebooks/examples/cc.ipynb). ::: @@ -23,7 +23,7 @@ from sec_certs.dataset.fips import FIPSDataset dset = FIPSDataset.from_web() ``` -to obtain to obtain freshly processed dataset from [sec-certs.org](https://sec-certs.org). +to obtain the freshly processed dataset from [sec-certs.org](https://sec-certs.org). 3. Play with the dataset. See [example notebook](./notebooks/examples/fips.ipynb). ::: diff --git a/docs/user_guide.md b/docs/user_guide.md index 8e6e2f4b..9191f689 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -11,16 +11,16 @@ Our tool matches certificates to their possible CVEs using datasets downloaded f Our tool can seamlessly download the required NVD datasets when needed. We support two download mechanisms: 1. Fetching datasets with the [NVD API](https://nvd.nist.gov/developers/start-here) (preferred way). -1. Fetching snapshots from seccerts.org. +1. Fetching snapshots from sec-certs.org. The following two keys control the behaviour: ```yaml -preferred_source_aux_datasets: "api" # set to "sec-certs" to fetch them from sec-certs.org +preferred_source_remote_datasets: "origin" # set to "sec-certs" to fetch them from sec-certs.org nvd_api_key: null # or the actual key value ``` -If you aim to fetch the sources from NVD, we advise you to get an [NVD API key](https://nvd.nist.gov/developers/request-an-api-key) and set the `nvd_api_key` setting accordingly. The download from NVD will work even without API key, it will just be slow. No API key is needed when `preferred_source_aux_datasets: "sec-certs"` +If you aim to fetch the sources from NVD, we advise you to get an [NVD API key](https://nvd.nist.gov/developers/request-an-api-key) and set the `nvd_api_key` setting accordingly. The download from NVD will work even without API key, it will just be slow. No API key is needed when `preferred_source_remote_datasets: "sec-certs"` ## Inferring inter-certificate reference context |