chore: update deployment scripts

Author: matiasdaloia

.github/workflows/release.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
         with:
-          fetch-depth: 0  # Get tags to allow build script to get build version
+          fetch-depth: 0 # Get tags to allow build script to get build version
 
       - name: Set up Go
         uses: actions/setup-go@v5
@@ -37,7 +37,8 @@ jobs:
         with:
           draft: true
           files: |
-            target/scanoss-hfh-api-linux-amd64
-            target/scanoss-hfh-api-linux-arm64
-            scanoss-hfh-api_linux-amd64_${{ github.ref_name }}-1.tgz
-            scanoss-hfh-api_linux-arm64_${{ github.ref_name }}-1.tgz
+            target/scanoss-folder-hashing-api-linux-amd64
+            target/scanoss-folder-hashing-api-linux-arm64
+            scanoss-folder-hashing-api_linux-amd64_${{ github.ref_name }}-1.tgz
+            scanoss-folder-hashing-api_linux-arm64_${{ github.ref_name }}-1.tgz
+

Makefile

@@ -233,11 +233,11 @@ release: docker_package_all ## Build and package everything for release
 package_amd: version  ## Build & Package an AMD 64 binary
 	@echo "Building AMD binary $(VERSION) and placing into scripts..."
 	go generate ./cmd/server/main.go
-	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -ldflags="-w -s" -o ./scripts/scanoss-hfh-api ./cmd/server/main.go
+	GOOS=linux GOARCH=amd64 CGO_ENABLED=0 go build -ldflags="-w -s" -o ./scripts/scanoss-folder-hashing-api ./cmd/server/main.go
 	bash ./package-scripts.sh linux-amd64 $(VERSION)
 
 package_arm: version  ## Build & Package an ARM 64 binary
 	@echo "Building ARM binary $(VERSION) and placing into scripts..."
 	go generate ./cmd/server/main.go
-	GOOS=linux GOARCH=arm64 CGO_ENABLED=0 go build -ldflags="-w -s" -o ./scripts/scanoss-hfh-api ./cmd/server/main.go
+	GOOS=linux GOARCH=arm64 CGO_ENABLED=0 go build -ldflags="-w -s" -o ./scripts/scanoss-folder-hashing-api ./cmd/server/main.go
 	bash ./package-scripts.sh linux-arm64 $(VERSION)

package-scripts.sh

@@ -41,7 +41,7 @@ export COPYFILE_DISABLE=true  # Required if packaging on OSX
 platform=$1
 version=$2
 build=1
-prefix_name="scanoss-hfh-api"
+prefix_name="scanoss-folder-hashing-api"
 tar_name="${prefix_name}_${platform}_${version}-${build}.tgz"
 # Get a unique archive name
 while [ -f "$tar_name" ] ; do

scripts/env-setup.sh

@@ -3,16 +3,16 @@
 ##########################################
 #
 # This script will copy all the required files into the correct locations on the server
-# Config goes into: /usr/local/etc/scanoss/hfh
-# Logs go into: /var/log/scanoss/hfh
+# Config goes into: /usr/local/etc/scanoss/folder-hashing-api
+# Logs go into: /var/log/scanoss/folder-hashing-api
 # Service definition goes into: /etc/systemd/system
 # Binary & startup go into: /usr/local/bin
 #
 ################################################################
 
 show_help() {
   echo "$0 [-h|--help] [-f|--force] [environment]"
-  echo "   Setup and copy the required files into place on a server to run the SCANOSS HFH API"
+  echo "   Setup and copy the required files into place on a server to run the SCANOSS Folder Hashing API"
   echo "   [environment] allows the optional specification of a suffix to allow multiple services"
   echo "   -f | --force  Run without interactive prompts (skip questions, skip SQLite setup, do not overwrite config)"
   exit 1
@@ -40,11 +40,11 @@ done
 
 ENVIRONMENT="${ENVIRONMENT:-$DEFAULT_ENV}"
 export BASE_C_PATH=/usr/local/etc/scanoss
-export CONFIG_DIR="${BASE_C_PATH}/hfh"
+export CONFIG_DIR="${BASE_C_PATH}/folder-hashing-api"
 export LOG_DIR=/var/log/scanoss
-export L_PATH="${LOG_DIR}/hfh"
+export L_PATH="${LOG_DIR}/folder-hashing-api"
 export DB_PATH_BASE=/var/lib/scanoss
-export SQLITE_PATH="${DB_PATH_BASE}/db/sqlite/hfh"
+export SQLITE_PATH="${DB_PATH_BASE}/db/sqlite/folder-hashing-api"
 export SQLITE_DB_NAME=base.sqlite
 export TARGET_SQLITE_DB_NAME=db.sqlite
 export CONF_DOWNLOAD_URL="https://raw.githubusercontent.com/scanoss/hfh/refs/heads/main/config/app-config-prod.json"
@@ -63,18 +63,18 @@ if [ "$EUID" -ne 0 ] ; then
 fi
 
 if [ "$FORCE" = false ]; then
-  read -p "Install SCANOSS HFH API $ENVIRONMENT (y/n) [n]? " -n 1 -r
+  read -p "Install SCANOSS Folder Hashing API $ENVIRONMENT (y/n) [n]? " -n 1 -r
   echo
   if [[ ! $REPLY =~ ^[Yy]$ ]] ; then
     echo "Stopping."
     exit 1
   fi
 else
-  echo "[FORCE] Auto-accept installation of SCANOSS HFH API $ENVIRONMENT"
+  echo "[FORCE] Auto-accept installation of SCANOSS Folder Hashing API $ENVIRONMENT"
 fi
 
 # Setup all the required folders and ownership
-echo "Setting up HFH API system folders..."
+echo "Setting up Folder Hashing API system folders..."
 mkdir -p "$CONFIG_DIR" || { echo "Error: Problem creating $CONFIG_DIR"; exit 1; }
 mkdir -p "$L_PATH" || { echo "Error: Problem creating $L_PATH"; exit 1; }
 
@@ -84,11 +84,11 @@ if [ "$RUNTIME_USER" != "root" ] ; then
 fi
 
 # Setup the service on the system
-SC_SERVICE_FILE="scanoss-hfh-api.service"
-SC_SERVICE_NAME="scanoss-hfh-api"
+SC_SERVICE_FILE="scanoss-folder-hashing-api.service"
+SC_SERVICE_NAME="scanoss-folder-hashing-api"
 if [ -n "$ENVIRONMENT" ] ; then
-  SC_SERVICE_FILE="scanoss-hfh-api-${ENVIRONMENT}.service"
-  SC_SERVICE_NAME="scanoss-hfh-api-${ENVIRONMENT}"
+  SC_SERVICE_FILE="scanoss-folder-hashing-api-${ENVIRONMENT}.service"
+  SC_SERVICE_NAME="scanoss-folder-hashing-api-${ENVIRONMENT}"
 fi
 
 service_stopped=""
@@ -102,7 +102,7 @@ echo "Copying service startup config..."
 if [ -f "$SC_SERVICE_FILE" ] ; then
   cp "$SC_SERVICE_FILE" /etc/systemd/system || { echo "Error: service copy failed"; exit 1; }
 fi
-cp scanoss-hfh-api.sh /usr/local/bin || { echo "Error: startup script copy failed"; exit 1; }
+cp scanoss-folder-hashing-api.sh /usr/local/bin || { echo "Error: startup script copy failed"; exit 1; }
 
 ####################################################
 #                SEARCH CONFIG FILE                #
@@ -198,7 +198,7 @@ find "$DB_PATH_BASE" -type d -exec chmod 0750 "{}" \;
 find "$DB_PATH_BASE" -type f -exec chmod 0640 "{}" \;
 
 # Copy the binaries if requested
-BINARY=scanoss-hfh-api
+BINARY=scanoss-folder-hashing-api
 if [ -f $BINARY ] ; then
   echo "Copying app binary to /usr/local/bin ..."
   cp $BINARY /usr/local/bin || { echo "Error copying $BINARY"; exit 1; }

scripts/scanoss-hfh-api.service renamed to scripts/scanoss-folder-hashing-api.service

@@ -1,5 +1,5 @@
 [Unit]
-Description=SCANOSS HFH API Service
+Description=SCANOSS Folder Hashing API Service
 After=network.target
 StartLimitIntervalSec=0
 
@@ -8,7 +8,7 @@ Type=simple
 Restart=always
 RestartSec=5
 User=scanoss
-ExecStart=/usr/local/bin/scanoss-hfh-api.sh
+ExecStart=/usr/local/bin/scanoss-folder-hashing-api.sh
 
 [Install]
 WantedBy=multi-user.target

scripts/scanoss-hfh-api.sh renamed to scripts/scanoss-folder-hashing-api.sh

@@ -9,8 +9,8 @@
 ################################################################
 DEFAULT_ENV="prod"
 ENVIRONMENT="${1:-$DEFAULT_ENV}"
-LOGFILE=/var/log/scanoss/hfh/scanoss-hfh-${ENVIRONMENT}.log
-CONF_FILE=/usr/local/etc/scanoss/hfh/app-config-${ENVIRONMENT}.json
+LOGFILE=/var/log/scanoss/folder-hashing-api/scanoss-folder-hashing-api-${ENVIRONMENT}.log
+CONF_FILE=/usr/local/etc/scanoss/folder-hashing-api/app-config-${ENVIRONMENT}.json
 # Rotate log
 if [ -f "$LOGFILE" ] ; then
   echo "rotating logfile..."
@@ -22,6 +22,6 @@ fi
 echo > "$LOGFILE"
 
 #start API
-echo "Starting SCANOSS HFH API"
+echo "Starting SCANOSS Folder Hashing API"
 
-exec /usr/local/bin/scanoss-hfh-api --json-config "$CONF_FILE" > "$LOGFILE" 2>&1
+exec /usr/local/bin/scanoss-folder-hashing-api --json-config "$CONF_FILE" > "$LOGFILE" 2>&1