Skip to main content

​
Installation

Note: The commands below download from the master branch. If the repository has been updated to use main or another default branch, adjust the URL accordingly.
Match your LDB and Engine versions. LDB 5.x and later ships two parallel release lines, a traditional one and a CRC64-compatible one (tagged with a -crc64 suffix, for example v5.0.0-crc64). Engine enforces the pairing at both build and run time, an Engine from one line refuses to run against an LDB from the other. See LDB and Engine Version Compatibility before upgrading either component.

​
Directory Setup

In production environments, the Knowledge Base (KB) is typically stored on a dedicated disk or logical volume. Create your KB directory as follows:
Note: Replace user with the username that will run the SCANOSS Engine.
Create a symbolic link from the default LDB path (/var/lib/ldb) to your KB directory:
The subdirectories (purl, url, file, wfp) are created automatically during the KB import process — you do not need to create them manually.

​
Verify Installation

Run the following command to confirm LDB is installed correctly:
You should see the following output:
To exit the LDB session, run:

​
Import Configuration

A table’s key length is fixed when it’s created and is set through the KEY_SIZE parameter in a bulk insert command’s CONFIG string or in a GLOBAL line of the database’s config file: KEY_SIZE=8 for CRC64-hashed keys, KEY_SIZE=16 for MD5-hashed keys (the long-standing default). An auto-generated DBNAME.conf (from create config DBNAME) now sets KEY_SIZE=8 by default, so building an MD5 table from scratch needs KEY_SIZE=16 added explicitly. Every table within one Knowledge Base should use the same KEY_SIZE. The import log location is also configurable, with LOG_PATH in the same CONFIG string or config file, for example LOG_PATH=/path/to/file.log. Left unset, it defaults to /var/log/scanoss/ldb/DBNAME.log, as before.