Skip to content

Commit

Permalink
chg: [documentation] Updated documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
cedricbonhomme committed Jan 10, 2025
1 parent dcaada2 commit af3da21
Show file tree
Hide file tree
Showing 23 changed files with 181 additions and 182 deletions.
1 change: 0 additions & 1 deletion content/news/2025-01-10-vulnerability-lookup-2-4-0.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ Discover more about Vulnerability-Lookup and its capabilities here:
https://vulnerability.circl.lu



🙏 Thank you very much to all the contributors and testers!


Expand Down
2 changes: 1 addition & 1 deletion content/sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ toc: true
## Sources and Feeders

- [CISA Known](https://www.cisa.gov/known-exploited-vulnerabilities-catalog) exploited vulnerability DB (via HTTP).
- NIST NVD CVE importer (via API 2.0).
- NIST NVD CVE importer (via API 2.0), Fraunhofer FKIE NVD.
- [CVEProject - cvelist](https://github.com/CVEProject/cvelist) (via git submodule repository).
- Cloud Security Alliance - [GSD-Database](https://github.com/cloudsecurityalliance/gsd-database/) (via git submodule repository).
- GitHub [Advisory Database](https://github.com/github/advisory-database) (via git submodule repository).
Expand Down
4 changes: 2 additions & 2 deletions static/documentation/_sources/command-line-interface.rst
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ Update MISP warning lists
$ flask --app website.app update_warninglists
During the update of Vulnerability Lookup, the administrator will be prompted to execute this command.
During the update of Vulnerability-Lookup, the administrator will be prompted to execute this command.


Backup the PostgreSQL database
Expand All @@ -132,4 +132,4 @@ Backup the PostgreSQL database
$ flask --app website.app db_backup
This command is executed automatically during the update ot Vulnerability Lookup.
This command is executed automatically during the update ot Vulnerability-Lookup.
4 changes: 2 additions & 2 deletions static/documentation/_sources/feeds.rst
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Recent vulnerabilities related to a vendor
<title>Most recent entries from cvelistv5</title>
<updated>2024-11-26T08:02:41.668408+00:00</updated>
<author>
<name>Vulnerability Lookup</name>
<name>Vulnerability-Lookup</name>
<email>[email protected]</email>
</author>
<link href="https://vulnerability.circl.lu" rel="alternate"/>
Expand Down Expand Up @@ -136,7 +136,7 @@ Recent vulnerabilities linked to the specified vulnerability
<title>Most recent entries from all</title>
<updated>2024-11-26T08:03:09.000211+00:00</updated>
<author>
<name>Vulnerability Lookup</name>
<name>Vulnerability-Lookup</name>
<email>[email protected]</email>
</author>
<link href="https://vulnerability.circl.lu" rel="alternate"/>
Expand Down
8 changes: 4 additions & 4 deletions static/documentation/_sources/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ In order to compile kvrocks, you will need a few packages:
Clone the source code
---------------------

Clone Vulnerability Lookup with the submodules.
Clone Vulnerability-Lookup with the submodules.

.. code-block:: bash
Expand Down Expand Up @@ -275,12 +275,12 @@ Create a file ``/etc/systemd/system/vulnerability-lookup-web.service`` with the
.. code-block:: ini
[Unit]
Description=Vulnerability Lookup webservice
Description=Vulnerability-Lookup webservice
After=network.target
[Service]
User=<system user used to install Vulnerability Lookup>
Group=<group of the user used to install Vulnerability Lookup>
User=<system user used to install Vulnerability-Lookup>
Group=<group of the user used to install Vulnerability-Lookup>
WorkingDirectory=<path to the directory where you cloned the repository>
Environment=PATH="<path-of-the-virtualenv>/bin/:/usr/bin"
ExecStart=/bin/bash -c "run_backend --start ; start_website"
Expand Down
2 changes: 1 addition & 1 deletion static/documentation/_sources/update.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Updating the CVE Record editor


We are using the `Vulnogram editor <https://github.com/Vulnogram/Vulnogram>`_.
The frontend is directly bundled in a HTML template of Vulnerability Lookup.
The frontend is directly bundled in a HTML template of Vulnerability-Lookup.

If you want to update the bundle you must first generate only the frontend of Vulnogram.
Follow the instructions
Expand Down
2 changes: 1 addition & 1 deletion static/documentation/_static/documentation_options.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '2.1.0',
VERSION: '2.4.0',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
Expand Down
4 changes: 2 additions & 2 deletions static/documentation/_static/files/swagger.json
Original file line number Diff line number Diff line change
Expand Up @@ -1387,7 +1387,7 @@
},
"vulnerability_lookup_origin": {
"type": "string",
"description": "UUID of the Vulnerability Lookup origin instance.",
"description": "UUID of the Vulnerability-Lookup origin instance.",
"readOnly": true,
"default": "1a89b78e-f703-45f3-bb86-59eb712668bd"
},
Expand Down Expand Up @@ -1592,7 +1592,7 @@
},
"vulnerability_lookup_origin": {
"type": "string",
"description": "UUID of the Vulnerability Lookup origin instance.",
"description": "UUID of the Vulnerability-Lookup origin instance.",
"readOnly": true,
"default": "1a89b78e-f703-45f3-bb86-59eb712668bd"
},
Expand Down
Loading

0 comments on commit af3da21

Please sign in to comment.