Skip to main content

Tools included

The image contains three tools:
  • ldb is the Linked-list database that stores Knowledge Base (KB) data.
  • minr is the mining tool that downloads and indexes open-source software (OSS) components.
  • scanoss is the scanning engine that queries the KB.

Quick start

1. Build the Docker image

2. Start the container

3. Create a Knowledge Base

4. Download test files

Download and extract the same archive to get a file to scan:

5. Scan the original file

An unmodified file should produce a 100% file match against the KB:
Expected output:

6. Modify the file

7. Scan the modified file

The modified file should produce a snippet match, because only part of its code matches:
Expected output:

8. Cleanup

End-to-end example

Scanning your own files

Copy files into the container

To scan files from your host machine, copy them into the container first:

Mount a volume

To scan a directory without copying each file, mount a volume when you start the container: