Skip to content

Commit f6b5a57

Browse files
committed
Improve the documentation for dataspace integrations #31
Signed-off-by: tdruez <tdruez@nexb.com>
1 parent 86cbe6c commit f6b5a57

File tree

1 file changed

+33
-11
lines changed

1 file changed

+33
-11
lines changed

docs/dataspace.rst

Lines changed: 33 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -329,9 +329,16 @@ You can:
329329
* Download the scan results to a JSON-formatted file to integrate with other
330330
analysis and reporting tools.
331331

332+
Install and configure ScanCode.io
333+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
334+
332335
.. warning::
333-
The ScanCode.io server **should not be installed on the same server** (virtual or
334-
physical) as the DejaCode one.
336+
If you plan to run ScanCode.io **on the same server** (virtual or physical) as
337+
the DejaCode instance, **ensure that the host machine has sufficient resources**
338+
to handle both applications.
339+
Also, you will have to provide custom network ports for the ScanCode.io application
340+
as the ports 80 and 443 will be already used by the DejaCode application.
341+
See https://scancodeio.readthedocs.io/en/latest/installation.html#use-alternative-http-ports
335342

336343
1. Install a ScanCode.io server following instructions at
337344
https://scancodeio.readthedocs.io/en/latest/installation.html
@@ -387,13 +394,21 @@ You can:
387394

388395
* Browse and search from a list of over **21 millions Packages**.
389396
* Get extra information on your local Packages from the **"PurlDB" tab**.
390-
* Create local Packages automatically from entries found in the PurlDB.
397+
* **Create local Packages automatically** from entries found in the PurlDB.
391398
* Enhance the **Global search** results with Packages from the PurlDB.
392399
* Check for **new Package versions** from your Products inventory
393400

394-
1. Get in touch with nexB to request your credentials for the **PurlDB** service.
401+
PurlDB service
402+
^^^^^^^^^^^^^^
403+
404+
A public instance of **PurlDB** is available at
405+
https://public.purldb.io/api/packages/
406+
407+
Alternatively, you have the option to run your instance of PurlDB by
408+
following the documentation provided at https://purldb.readthedocs.io/
395409

396-
2. Set the PurlDB Server URL and API key in your Dataspace Configuration:
410+
Set the PurlDB Server URL and API key in your Dataspace Configuration
411+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
397412

398413
- Access your DejaCode web application **Administration dashboard**.
399414
- Navigate to the **Dataspaces** section and select your Dataspace name.
@@ -412,9 +427,9 @@ Enable VulnerableCodeDB service
412427
===============================
413428

414429
DejaCode integration with the **VulnerableCodeDB** service authorizes DejaCode to access
415-
the VulnerableCodeDB using a Package URL (purl) to determine if there are any reported
416-
vulnerabilities for a specific Package and return the Vulnerability ID and related URLs
417-
to a Vulnerabilities tab in the Package details user view.
430+
the VulnerableCodeDB using a Package URL (purl) to determine if there are any
431+
**reported vulnerabilities for a specific Package** and return the Vulnerability ID
432+
and related URLs to a **Vulnerabilities tab** in the **Package details** user view.
418433

419434
DejaCode displays a Vulnerability icon next to the Package identifier in the user view
420435
list, and also in any Product Inventory list using that Package.
@@ -429,10 +444,17 @@ You can:
429444
* Review and edit your Product Package assignments to record your analysis, the actions
430445
you have taken, and the current status of your usage of that Package.
431446

432-
1. Get in touch with nexB to request your credentials for the **VulnerableCodeDB**
433-
service.
447+
VulnerableCodeDB service
448+
^^^^^^^^^^^^^^^^^^^^^^^^
449+
450+
A public instance of **VulnerableCodeDB** is available at
451+
https://public.vulnerablecode.io/api/
452+
453+
Alternatively, you have the option to run your instance of VulnerableCodeDB by
454+
following the documentation provided at https://vulnerablecode.readthedocs.io/
434455

435-
2. Set the VulnerableCodeDB Server URL and API key in your Dataspace Configuration:
456+
Set the VulnerableCodeDB Server URL and API key in your Dataspace Configuration
457+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
436458

437459
- Access your DejaCode web application **Administration dashboard**.
438460
- Navigate to the **Dataspaces** section and select your Dataspace name.

0 commit comments

Comments
 (0)