FossID Documentation

Installation in Linux

Assumptions

  • The CLI tools are by default installed at /usr/bin
  • The system uses a deb or rpm package manager

1. Access the deliverables

Access information to the FossID deliverables is provided in the delivery mail. Download and extract the fossid-cli-tools-VERSION.zip.

1.1. Install the FossID deliverable

Debian / Ubuntu:

sudo dpkg -i fossid-cli-tools-VERSION_amd64.deb

RedHat:

sudo yum localinstall fossid-cli-tools-VERSION_amd64.rpm

2. FossID CLI pre-requisites

2.1. Install packages required by CLI

Debian / Ubuntu:

Update package repository:

sudo apt-get update

Install packages:

sudo apt-get -y install default-jre

Redhat:

Install packages:

sudo yum -y install java-11-openjdk

2.2 Test that all is installed correctly

Run the following test command to test whether CLI tools have access to the can server.

fossid-cli --host YOUR_SERVER_HOST --token YOUR_TOKEN --test-route

Note: The host address and the token have been provided to you at your FossID delivery site. If you do not use FossID’s scan servers, tokens are administered by your scan server administrator.

3. FossID Configuration

3.1. Basic fossid.conf settings

Fossid configuration file can be used to configure the scan server credentials and additional scan options.

To configure the scan server credentials:

1.- Access /etc/fossid.conf

2.- Configure Scan server access: Update these config options with info at your FossID delivery site, or by your scan server admin if you do not use FossID’s scan servers.

cli_server_host = YOUR_SERVER_HOST
cli_token = YOUR_TOKEN

3.- Save your fossid.conf file. Note the change to configuration is immediate, no restart is required.

Proxy configuration and additional options for the CLI tools is available in the same file.

4. Using FossID

For configuration options and usage examples, run

fossid-cli --help