Downloading the SCANOSS Knowledge Base

Instructions for obtaining and configuring the SCANOSS Knowledge Base for on-premise deployments.

In order to have access to the full capabilities of SCANOSS, you need to deploy several components:

• The LDB, the database that will contain the Knowledge Base
• The SCANOSS Engine, the inventory engine, that provides scanning and searching capabilities over LDB
• The SCANOSS Encoder Library, to provide data encoding capabilities
• The API, provides a simple RESTful API for SCANOSS that can be accessed remotely by any clients, such as SCANOSS-PY

This section describes how to securely download and prepare the Knowledge Base for your local installation.

Secured Access

You will receive authentication details via email for accessing the SCANOSS Knowledge Base.

Connection through CLI

You can copy the Knowledge Base database using Secure FTP (SFTP) connection, authenticating with your provided credentials.

Run the following command to connect:

sftp -P PORT USER@HOST

Example:

sftp -P 49322 [e-mail]

Downloading Files

Once connected, you’ll enter an interactive shell where you can download files using the get command:

sftp> get {{ file_path }}

All content under /ldb/oss/ is required for the installation and must be downloaded locally.

To download the entire directory recursively, use the -r flag:

sftp> get -r {{ file_dir }}

Example: Download all Knowledge Base tables for the 23.08 monthly release:

sftp> get -r /ldb/compressed/full/23.08/

Connecting via FTP Client

Configure your preferred FTP client to connect and download files. Refer to the screenshot below and enter the connection details exactly as shown.

Usage instructions

In order to use the downloaded Knowledge Base, you should place the oss directory under the /var/lib/ldb directory.

You can copy its content directly to the directory, mount a volume or create a symbolic link if it is located in a separate disk.

For example, if your LDB is downloaded at /data/ldb, to creating a symbolic link enter:

sudo ln -s /data/ldb /var/lib/ldb

Set Permissions

After placing the Knowledge Base files, ensure that the scanoss user has ownership of the oss directory. This is critical to avoid permission issues during operation:

sudo chown -R scanoss:scanoss /var/lib/ldb/oss

This step is necessary because if the files were created or copied as root, the scanoss user may not have the required permissions to read them.

Once all files are correctly placed and permissions are set, proceed with the Installation from Sources