{"id":48939961,"url":"https://github.com/scanoss/scanoss-engine","last_synced_at":"2026-04-17T13:11:49.714Z","repository":{"id":225352181,"uuid":"486683467","full_name":"scanoss/scanoss-engine","owner":"scanoss","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-12T13:38:06.000Z","size":40,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-09-15T18:41:53.620Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scanoss.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSES/GPL-2.0-only.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-28T17:12:34.000Z","updated_at":"2024-09-12T13:38:10.000Z","dependencies_parsed_at":"2024-04-18T17:39:24.747Z","dependency_job_id":"a88edf35-601b-4c49-ab95-ea8117af5195","html_url":"https://github.com/scanoss/scanoss-engine","commit_stats":null,"previous_names":["scanoss/scanoss-engine"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/scanoss/scanoss-engine","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanoss%2Fscanoss-engine","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanoss%2Fscanoss-engine/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanoss%2Fscanoss-engine/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanoss%2Fscanoss-engine/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scanoss","download_url":"https://codeload.github.com/scanoss/scanoss-engine/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scanoss%2Fscanoss-engine/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31930255,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-17T12:37:54.787Z","status":"ssl_error","status_checked_at":"2026-04-17T12:37:25.095Z","response_time":62,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-04-17T13:11:49.057Z","updated_at":"2026-04-17T13:11:49.701Z","avatar_url":"https://github.com/scanoss.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SCANOSS Platform: Containerized Environment\n\nThe scanoss-engine repository offers a containerized environment, simplifying deployment with essential software components and dependencies encapsulated within a single Docker container. These components include:\n\n- [LDB](https://github.com/scanoss/ldb)\n- [Engine](https://github.com/scanoss/engine)\n- [API](https://github.com/scanoss/api.go)\n\n# Quick start\n\nTo initiate SCANOSS using our sample Knowledge Base [test-kb](https://github.com/scanoss/test-kb), follow these steps:\n\n1. Clone this repository\n\n    ```sh\n    git clone https://github.com/scanoss/scanoss-engine\n    ```\n\n2.  Execute the `start.sh` script. This script pulls our test Knowledge Base (~40GB uncompressed) containing example components and starts the SCANOSS container. \n    \n    ```sh\n    cd scanoss-engine/\n    ./start.sh\n    ```\n    \n    Notes:\n    - The example KB will be downloaded in the `./ldb` folder and the download will be skipped if the `ldb` folder exists. \n    - The API is configured to listen on port 8083. \n    - Please review the script for further reference.\n\n3. Test your environment by running a scan request using the [Python CLI](https://github.com/scanoss/scanoss.py):\n\n    From another terminal you can run a scan against the container. If the scan was successfull, you will receive the match output.\n    \n    ```sh\n    scanoss-py scan --apiurl http://localhost:8083/api/scan/direct test-data/\n    ```\n\n# Customization\n\nCustomization options are available through scripts and configuration files found under the `scripts` folder:\n\n- `app-config-prod.json`: API Configuration. See [api.go](https://github.com/scanoss/api.go) for reference\n- `env-setup.sh`: Container-optimized API setup script.\n\n# Building your own container image\n\nFollow these steps if you want to build your own image. \n\nPre-requisites:\n\n- A Knowledge Base. You may reuse the example KB downloaded in the [Quick Start](#quick-start) section or mine your own components following the [minr guide](https://github.com/scanoss/minr) and the [test kb](https://github.com/scanoss/test-kb/blob/master/util/kb-mine.sh) mining script. Ensure sufficient disk storage for mining required components. \n\nSteps:\n\n1. Clone this repository or download and extract the repository source package.\n\n    ```sh\n    git clone https://github.com/scanoss/scanoss-engine\n    cd scanoss-engine/\n    ```\n\n2. Build the container image:\n\n    To build the image, use the following command:\n\n    ```sh\n    docker build -t scanoss-engine .\n    ```\n\n    This command creates an image named \"scanoss-engine\".\n\n3. Run a container:\n\n    Once the image is built, run the container with all required components available out of the box.\n\n    Replace `\u003cLDB_DATA_DIR\u003e` with a local directory containing the Knowledge Base in the Docker host.\n\n    ```sh\n      docker run --rm \\\n        -p 8083:8083 \\\n        -v \u003cLDB_DATA_DIR\u003e:/var/lib/ldb \\\n        -it scanoss-engine\n    ```\n    \n    - The API is configured to listen on port 8083.\n    \n    - The SCANOSS engine looks for databases in `/var/lib/ldb/`. \n    \n    - The configuration variable `ScanningURL` defines the base URL for the source file's URL present in the output response.\n\n4. Test your environment:\n\n    Once the container is running, query the API and run scans against the new Knowledge Base.\n\n    To verify the installation, scan a component from the mining list using the Python CLI:\n\n    ```sh\n    \n    scanoss-py scan --apiurl http://localhost:8083/api/scan/direct test-data/\n    ```\n\n    The scanning results will include matches to the mined component.\n\n\nNote: The Docker image is based on amd64 binaries. On non-amd64 processors you need to pass the option: `--platform linux/amd64` to the `docker run` command to enable compatibility:\n\n```sh\ndocker run --platform linux/amd64 ...\n```\n\n# License\n\nThe Scanoss Platform is entirely released under the GPL 2.0 license. Please check the LICENSE file for more information.\n\nCopyright (C) 2018-2020 SCANOSS.COM\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscanoss%2Fscanoss-engine","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscanoss%2Fscanoss-engine","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscanoss%2Fscanoss-engine/lists"}