Merge pull request #37 from lucee/LDEV-5944

LDEV-5944 use service name for linux installer

Author: zspitzer

.github/workflows/main.yml

@@ -389,15 +389,15 @@ jobs:
             --installiis false \
             --startatboot false \
             --luceepass ibtest \
-            --systemuser lucee \
+            --systemuser ${{ matrix.user }} \
             --installjre ${{ env.INSTALL_JRE }}
 
           sleep 10;
 
           sudo ls -l /var/www/html
           sudo chown -R apache:apache /var/www/html
           sudo chmod o+w /var/www/html
-          sudo usermod -a -G apache ${{matrix.user}}
+          sudo usermod -a -G apache ${{ matrix.user }}
 
           echo "Write out simple test script to confirm Lucee / Java / Tomcat versions" | tee -a $GITHUB_STEP_SUMMARY
 

LDEV-5944-status.md

@@ -0,0 +1,77 @@
+# LDEV-5944 Status - Linux Service Name Support
+
+## Issue
+Linux installer hardcodes `lucee_ctl` service name, preventing multiple Lucee installations side-by-side.
+
+## PR
+https://github.com/lucee/lucee-installer/pull/37
+
+## CI Run
+https://github.com/lucee/lucee-installer/actions/runs/19765897410
+
+## Changes Made
+
+### 1. Configurable Service Name (LDEV-5944)
+- Added `servicename` parameter to installer UI
+- Platform defaults: Windows = `Lucee`, Linux = `lucee`
+- Linux control script becomes `${servicename}_ctl` (e.g., `lucee_ctl`, `myapp_ctl`)
+- Updated `service_config.sh` with `--name` parameter
+- Updated `change_user.sh` to accept service name as 4th argument
+- Updated `lucee.xml` to use `${servicename}_ctl` everywhere
+- Updated uninstaller to use configurable service name
+
+### 2. PR #35 Bug Fixes (merged first)
+- Fixed `checkGroupExists()` - was using `id -g` instead of `getent group`
+- Fixed `rebuildControlScript()` - `mv` failed on fresh install when file doesn't exist
+- Fixed template name mismatch - `lucee.xml` referenced `engine_ctl_template` but PR #35 renamed it to `lucee_ctl_template`
+
+### 3. Fail-Fast Error Handling
+- Added `set -e` to `lucee_ctl_template`
+- Added `abortOnError` and `onErrorActionList` to lucee.xml for the start command
+- Installer now fails immediately with clear error instead of waiting for Tomcat timeout
+
+### 4. `su` Command Fixes
+- Problem: Docker containers don't have `su` in PATH or installed
+- First attempt: Changed `su` to `/usr/bin/su` - failed on AlmaLinux where `su` is at `/bin/su`
+- Second attempt: Changed to `/bin/su` - failed because AlmaLinux `almalinux:latest` doesn't have `util-linux` installed
+- Current fix: Added `run_as_owner()` helper function that skips `su` when current user matches target user
+
+## Current `run_as_owner` Implementation
+```bash
+run_as_owner() {
+    if [ "$(id -un)" = "$TOMCAT_OWNER" ]; then
+        "$@"
+    else
+        /bin/su -p -s /bin/sh "$TOMCAT_OWNER" "$@"
+    fi
+}
+```
+
+## CI Test Matrix
+| Platform | Container | Users Tested |
+|----------|-----------|--------------|
+| Ubuntu x64 | Native runner | $USER, root, lucee |
+| Ubuntu aarch64 | Native runner | $USER, root, lucee |
+| Debian 12 | debian:12 | root, lucee |
+| AlmaLinux | almalinux:latest | root, lucee |
+| Windows | Native runner | N/A |
+
+## Known Issues
+
+### AlmaLinux CI Workflow Bug
+Line 392 in main.yml always uses `--systemuser lucee` regardless of matrix user variable.
+
+### `su` Still Required for Non-Matching Users
+When running as root with `--systemuser lucee`, the script still needs `su` which may not be installed in minimal containers.
+
+## Files Modified
+- `lucee/lucee.xml` - service name support, fail-fast, template name fix
+- `lucee/linux/sys/lucee_ctl_template` - `set -e`, `run_as_owner()` function
+- `lucee/linux/sys/change_user.sh` - service name support, getent group fix, mv fix
+- `lucee/linux/sys/service_config.sh` - `--name` parameter
+- `lucee/translations/messages.en.txt` - renamed message keys
+
+## Next Steps
+1. Wait for CI to complete
+2. Check failed logs for actual error
+3. May need to install `util-linux` in CI workflow for AlmaLinux if `su` is still needed

lucee/linux/sys/change_user.sh

@@ -6,12 +6,10 @@
 # Author:	Jordan Michaels (jordan@viviotech.net)
 # Copyright:	Jordan Michaels, 2010-2018, All rights reserved.
 #
-# Usage: 	change_user.sh [username] [install dir] [engine] [nobackup]
+# Usage: 	change_user.sh username /path/to/installdir [nobackup] [servicename]
 #
-#		[username] must start with a lower-case letter and must be alpha-
-#		numeric
-#		[engine] must be either "lucee" or "openbd". Engine name is used
-#		in the control script name, such as "lucee_ctl" or "openbd_ctl"
+#		username must start with a lower-case letter and must be alphanumeric
+#		servicename is optional, defaults to lucee_ctl
 # ----------------------------------------------------------------------------------
 #
 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
@@ -74,31 +72,24 @@ else
 	myInstallDir=$2;
 fi
 
-# the default when [nobackup] is not specified is always to backup control scripts
-if [[ -z "$3" ]]; then
-	echo "lucee_ctl will be backed up to lucee_ctl.old";
-	myControlNeedsBackup=1;
-else
-	if [[ "$3" = "openbd" ]]; then
-		echo "Error: OpenBD is no longer supported by this script.";
-		exit 1;
-	else
-		if [[ -z "$4" ]]; then
-			echo "lucee_ctl will be backed up to lucee_ctl.old";
-			myControlNeedsBackup=1;
-		else
-			# At this point $3 and $4 both exist.
-			# The legacy $3 argument (lucee) is ignored,
-			# but the old usage is supported to avoid breaking change!
-			if [[ "$3" = "nobackup" || "$4" = "nobackup" ]]; then
-				echo "lucee_ctl will NOT be backed up!";
-				myControlNeedsBackup=0;
-			else
-				echo "lucee_ctl will be backed up to lucee_ctl.old";
-				myControlNeedsBackup=1;
-			fi
-		fi
+# default service name
+myServiceName="lucee_ctl"
+
+# parse optional arguments
+myControlNeedsBackup=1
+for arg in "$3" "$4"; do
+	if [[ "$arg" = "nobackup" ]]; then
+		myControlNeedsBackup=0
+	elif [[ -n "$arg" && "$arg" != "lucee" ]]; then
+		# treat non-empty, non-legacy values as service name
+		myServiceName="$arg"
 	fi
+done
+
+if [[ ${myControlNeedsBackup} -eq 1 ]]; then
+	echo "${myServiceName} will be backed up to ${myServiceName}.old";
+else
+	echo "${myServiceName} will NOT be backed up!";
 fi
 
 ###################
@@ -120,7 +111,7 @@ function checkUserExists {
 function checkGroupExists {
 	echo -n "Checking to see if group exists...";
 	myGroupNeedsCreating=0;
-	if id -g "${myUserName}" >/dev/null 2>&1; then
+	if getent group "${myUserName}" >/dev/null 2>&1; then
 		echo "[FOUND]";
 	else
 		echo "[NOT FOUND]";
@@ -174,28 +165,28 @@ function processControlScriptTemplate {
 function rebuildControlScript {
 	echo "Rebuilding Control Scripts for new User...";
 	# backup current control script
-	if [[ ${myControlNeedsBackup} -eq 1 ]]; then
-		# If we're backing up, do it
-		mv ${myInstallDir}/lucee_ctl ${myInstallDir}/lucee_ctl.old;
+	if [[ ${myControlNeedsBackup} -eq 1 && -f "${myInstallDir}/${myServiceName}" ]]; then
+		# If we're backing up and file exists, do it
+		mv ${myInstallDir}/${myServiceName} ${myInstallDir}/${myServiceName}.old;
 	else
 		# otherwise, just remove the old file
-		rm -f ${myInstallDir}/lucee_ctl
+		rm -f ${myInstallDir}/${myServiceName}
 	fi
-	
+
 	# create the control script from easier to maintain separate template
-	TomcatControlScript="${myInstallDir}/lucee_ctl";
+	TomcatControlScript="${myInstallDir}/${myServiceName}";
 	local scriptDir="$(dirname "${BASH_SOURCE[0]}")"
-	
+
 	# Process the template to generate the control script
 	processControlScriptTemplate "${scriptDir}/lucee_ctl_template" "$TomcatControlScript"
-	
+
 	# make it executable
-	chmod 744 $TomcatControlScript;	
+	chmod 744 $TomcatControlScript;
 
 	# see if there's a control script in the init directory
-	if [[ -f /etc/init.d/lucee_ctl ]]; then
+	if [[ -f /etc/init.d/${myServiceName} ]]; then
 		# if there is, copy the new control script over it
-		cp -f $TomcatControlScript /etc/init.d/lucee_ctl;
+		cp -f $TomcatControlScript /etc/init.d/${myServiceName};
 	fi
 }
 

lucee/linux/sys/lucee_ctl_template

@@ -1,4 +1,5 @@
 #!/bin/bash
+set -e
 # chkconfig: 345 22 78
 # description: Tomcat/Lucee Control Script
 
@@ -25,17 +26,34 @@ CATALINA_TMPDIR=${myInstallDir}/tomcat/temp; export CATALINA_TMPDIR
 @@luceeJAVAhome@@
 TOMCAT_OWNER=${myUserName}; export TOMCAT_OWNER
 
+# Run a command as TOMCAT_OWNER
+# Tries multiple methods: direct execution, runuser, sudo, su
+run_as_owner() {
+	if [ "$(id -un)" = "$TOMCAT_OWNER" ]; then
+		"$@"
+	elif command -v runuser >/dev/null 2>&1; then
+		runuser -u "$TOMCAT_OWNER" -- "$@"
+	elif command -v sudo >/dev/null 2>&1; then
+		sudo -u "$TOMCAT_OWNER" "$@"
+	elif command -v su >/dev/null 2>&1; then
+		su -p -s /bin/sh "$TOMCAT_OWNER" -- "$@"
+	else
+		echo "ERROR: Cannot switch to user $TOMCAT_OWNER - no runuser, sudo, or su available" >&2
+		return 1
+	fi
+}
+
+# Check if Lucee/Tomcat is running by examining the PID file
 checkisrunning() {
 	LUCEE_IS_RUNNING=0
 	# delete stale PID caused by server reboot
 	if [[ -f "$CATALINA_PID" && /proc -nt "$CATALINA_PID" ]]; then
 		rm "$CATALINA_PID"
 	fi
-	if [ -f "$CATALINA_PID" ] ; then
-		PIDNUMBER=`cat "$CATALINA_PID"`
-		TEST_RUNNING=`ps -p ${PIDNUMBER} | grep ${PIDNUMBER} | grep java`
-		if [ ! -z "${TEST_RUNNING}" ]; then 
-			# PID is found and running
+	if [ -f "$CATALINA_PID" ]; then
+		PIDNUMBER=$(cat "$CATALINA_PID")
+		# check if process is running - use kill -0 which is cleaner than grepping ps output
+		if kill -0 "$PIDNUMBER" 2>/dev/null; then
 			LUCEE_IS_RUNNING=1
 		fi
 	fi
@@ -45,7 +63,7 @@ start() {
 	echo " * Starting Lucee: "
 	checkisrunning
 	if [ $LUCEE_IS_RUNNING -eq 0 ] ; then
-		su -p -s /bin/sh $TOMCAT_OWNER $CATALINA_HOME/bin/startup.sh
+		run_as_owner $CATALINA_HOME/bin/startup.sh
 		echo -n " * Waiting for confirmation that Lucee is running: "
 		COUNT=0
 		while [ $LUCEE_IS_RUNNING -eq 0 ] ; do
@@ -79,7 +97,7 @@ stop() {
 	echo -n " * Shutting down Lucee: "
 	checkisrunning
 	if [ $LUCEE_IS_RUNNING -eq 1 ] ; then
-		su -p -s /bin/sh $TOMCAT_OWNER $CATALINA_HOME/bin/shutdown.sh &> /dev/null &
+		run_as_owner $CATALINA_HOME/bin/shutdown.sh &> /dev/null &
 		COUNT=0
 		while [ $LUCEE_IS_RUNNING -eq 1 ] ; do
 			COUNT=$((${COUNT}+1))