Skip to content

README.md

Latest commit

 

History

History
51 lines (37 loc) · 2.03 KB

README.md

File metadata and controls

51 lines (37 loc) · 2.03 KB

SCANOSS Scanning Service Deployment Support

This folder contains convenience utilities for deploying, configuring and running the SCANOSS Scanning GO API service.

Setup

The scripts folder contains an env_setup.sh script which attempts to do the following:

  • Set up the default folders
  • Set permissions
  • Set up service registration (scanoss-go-api.service)
  • Copy in binaries (if scanoss-go-api and/or scanoss exist in the folder)
  • Copy in preferred configuration (if app-config-prod.json exists in the folder)

A sample production configuration file can be found in config/app-config-prod.json.

Logs are written by default to /var/log/scanoss/api/scanoss-api-prod.log.

Configuration is written by default to: /usr/local/etc/scanoss/api.

Installation

Running the env_setup.sh on the target server, takes care of installation. Simply run:

./env_setup.sh

This will copy the configuration files to /usr/local/etc/scanoss/api the binaries to /usr/local/bin and the service registration to /etc/systemd/system.

It will also redirect logging to /var/log/scanoss/api.

Multi-service Registration

If there is a need to deploy more than one API service on the same server, this can be achieved by using a different ENVIRONMENT name.

Create a copy of the scanoss-go-api.service using the following command:

cp scanoss-go-api.service scanoss-go-api-<env>.service

Where env is the name of this edition of the service (i.e. dev).

The app-config-prod.json file will also need to be copied:

cp app-config-prod.json app-config-<env>.json

Note: Please remember to use a different port number.

Finally, run the environment setup script using:

./env_setup.sh <env>

This will search for these specific service & config files and place them in the correct location.

Details for starting/stopping the service will be displayed in the console at the end of installation.