SCANOSS Platform 2.0 Components

Welcome to the component server for SCANOSS Platform 2.0

Warning Work In Progress Warning

Repository Structure

This repository is made up of the following components:

• ?

Configuration

Environmental variables are fed in this order:

dot-env --> env.json --> Actual Environment Variable

These are the supported configuration arguments:

APP_NAME="SCANOSS Component Server"
APP_PORT=50051
APP_MODE=dev
APP_DEBUG=false

# The serving knowledge base. DuckDB is the production backend.
DB_DRIVER=duckdb                    # duckdb, sqlite or postgres
DB_PATH=/var/lib/scanoss/serving.duckdb   # required by duckdb and sqlite; opened read-only

# To serve the same schema from a PostgreSQL instance instead:
# DB_DRIVER=postgres
# DB_DSN=postgres://user:pass@host/db?sslmode=disable
# The DB_* values below are only used to build a DSN when DB_DSN is empty,
# and only for the postgres driver.
# DB_HOST=localhost
# DB_USER=scanoss
# DB_PASSWD=
# DB_SCHEMA=scanoss
# DB_SSL_MODE=disable

Status mapping

User can define custom status mapping using STATUS_MAPPING variable (JSON format)

STATUS_MAPPING='{"unlisted":"removed","yanked":"removed","deleted":"deleted","deprecated":"deprecated","unpublished":"removed","archived":"deprecated","active":"active"}'

Docker Environment

The component server can be deployed as a Docker container.

Adjust configurations by updating an .env file in the root of this repository.

How to build

You can build your own image of the SCANOSS Component Server with the docker build command as follows.

make ghcr_build

How to run

Run the SCANOSS Component Server Docker image by specifying the environmental file to be used with the --env-file argument.

You may also need to expose the APP_PORT on a given interface:port with the -p argument.

docker run -it -v "$(pwd)":"$(pwd)" -p 50051:50051 ghcr.io/scanoss/scanoss-components -json-config $(pwd)/config/app-config-docker-local-dev.json -debug

Development

To run locally on your desktop, please use the following command:

go run cmd/server/main.go -json-config config/app-config-dev.json -debug