Overview - SCANOSS documentation

This section covers everything required to install, configure, and verify a self-hosted SCANOSS deployment. All installation scripts and resources referenced in this guide are available in the scanoss/on-premise repository.

TL;DR

For users who want to get up and running quickly:

# 1. Clone the repository
git clone https://github.com/scanoss/on-premise.git

# 2. Add execution permissions to the installation scripts
cd on-premise/install/ && chmod +x *.sh

# 3. Install SCANOSS applications — choose option 1) Install everything
sudo ./install-scanoss.sh

# 4. Run the Knowledge Base script — choose whether to install the Full KB, the Test KB, update an existing KB, a SQLite KB snapshot, or an HFH KB snapshot.
sudo ./kb-download.sh

If you downloaded a KB update, run the ldb-import.sh script included in the download folder to import it into your local LDB.

Installation Flow

To better understand the installation process, refer to the Installation Flow Diagram below.