Merge pull request #8 from virtuosoft-dev/version2.0.0

Version2.0.0

Author: Steveorevo

README.md

@@ -1,10 +1,10 @@
 # hcpp-nodeapp
 A plugin for Hestia Control Panel (via [hestiacp-pluginable](https://github.com/virtuosoft-dev/hestiacp-pluginable)) that enables hosting generic NodeJS based applications with control via [PM2 (Process Manager)](https://pm2.keymetrics.io). With this plugin installed, user accounts can host their own NodeJS applications. A simple [Hello World! ExpressJS application](https://expressjs.com/en/starter/hello-world.html) is included as the default NodeApp application. [NVM (NodeJS Version Manager)](https://github.com/nvm-sh/nvm) is also included and the default PM2 configuration file will automatically select the proper NodeJS version based on the simple .nvmrc file. 
 
+Version 2.0.0 now includes a (PM2 based) process list UI within HestiaCP that lists all NodeApps for a given user account under the Web tab (see #1 in screenshot below). Additional controls have been added to allow for Start, Stop, and Restart with bulk actions and viewing of the log output for each NodeApp process (see #2 in screenshot below).
 
-
-
-
+<br><img src='images/nodeapp-pm2.jpg' width='100%'><br>
+<sub>Figure 1 - NodeApp process list, control, and logs</sub>
 
 Long term support NodeJS versions that are automatically installed with this plugin include:
 
@@ -13,57 +13,54 @@ Long term support NodeJS versions that are automatically installed with this plu
 * Iron v20
 * Jod v22
 
-&nbsp;
-## Installation
-HCPP-NodeApp requires an Ubuntu or Debian based installation of [Hestia Control Panel](https://hestiacp.com) in addition to an installation of [HestiaCP-Pluginable](https://github.com/virtuosoft-dev/hestiacp-pluginable) to function; please ensure that you have first installed pluginable on your Hestia Control Panel before proceeding. Switch to a root user and simply clone this project to the /usr/local/hestia/plugins folder. It should appear as a subfolder with the name `nodeapp`, i.e. `/usr/local/hestia/plugins/nodeapp`.
+NodeApp also includes an updated administrator's [Server Settings -> Updates]() screen (see figure 2 below) that shows the current state of NVM NodeJS  versions. All versions are automatically updated and maintained along with any global modules when HestiaCP's native [Enable Automatic Updates]() option is turned on.
 
-First, switch to root user:
-```
-sudo -s
-```
+<br><img src='images/updates.png' width='100%'><br>
 
-Then simply clone the repo to your plugins folder, with the name `nodeapp`:
+&nbsp;
+## Installation
+HCPP-NodeApp requires an Ubuntu or Debian based installation of [Hestia Control Panel](https://hestiacp.com) in addition to an installation of [HestiaCP-Pluginable](https://github.com/virtuosoft-dev/hestiacp-pluginable) to function; please ensure that you have first installed pluginable on your Hestia Control Panel before proceeding. Clone the latest release version (i.e. replace **v2.0.0** below with the latest release version) to the nodeapp folder:
 
 ```
 cd /usr/local/hestia/plugins
-git clone https://github.com/virtuosoft-dev/hcpp-nodeapp nodeapp
+sudo git clone --branch v2.0.0 https://github.com/virtuosoft-dev/hcpp-nodeapp nodeapp
 ```
 
 Note: It is important that the destination plugin folder name is `nodeapp`.
 
-
 Be sure to logout and login again to your Hestia Control Panel as the admin user or, as admin, visit Server (gear icon) -> Configure -> Plugins -> Save; the plugin will immediately start installing NodeJS depedencies in the background. 
 
 <br><img src='images/nodeapp-notify.jpg' width='50%'><br>
-<sub>Figure 1 - NodeApp plugin install notification</sub>
+<sub>Figure 3 - NodeApp plugin install notification</sub>
 
 A notification will appear under the admin user account indicating *"NodeApp plugin has finished installing"* when complete. This may take awhile before the options appear in Hestia. You can force manual installation via:
 
 ```
 cd /usr/local/hestia/plugins/nodeapp
-./install
-touch "/usr/local/hestia/data/hcpp/installed/nodeapp"
+sudo ./install
+sudo touch "/usr/local/hestia/data/hcpp/installed/nodeapp"
 ```
 
 &nbsp;
 ## Using NodeApp to Host a NodeJS Website
 The Hestia user account to be associated with a new web domain must have bash SSH access. This is to allow Hestia to switch to their user account to start and stop the NodeJS application. Login as the admin user in Hestia to grant bash SSH Access. Simply edit the Hestia user account; 1) Click the *'Advanced Options'* button after ***'Edit User'*** and 2) Select `bash` from the combobox under ***'SSH Access'***, and save the changes (see image below).
 
 <br><img src='images/enable-bash.jpg' width='50%'><br>
-<sub>Figure 2 - Enable Bash for domain</sub>
+<sub>Figure 4 - Enable Bash for domain</sub>
 
 The basic default NodeJS application is the [Hello World! ExpressJS application](https://expressjs.com/en/starter/hello-world.html). To use it, simply select the user account (that has bash SSH access enabled), and add a web domain. Edit the web domain; 1) Click the ***'Advanced Options'*** and 2) Select `NodeApp` in the ***'Proxy Template'*** combobox (if the option is missing, wait for installation to complete or attempt manual installation instructions above).
 
 <br><img src='images/nodeapp.jpg' width='50%'><br>
-<sub>Figure 3 - Selecting a Proxy Template</sub>
+<sub>Figure 5 - Selecting a Proxy Template</sub>
 
 ## Root NodeJS Application Hosting
 Using the NodeApp proxy template will allow you to host a NodeJS application from the web domain root (for a subfolder, see **'Subfolder NodeJS Application below'**). The example above will serve the NodeJS application using PM2. After saving your changes, you should be able to visit the web domain and see the `Hello World!` text on a white background. The basic NodeJS Express application lives in the `app.js` file which is located in the nodeapp folder. I.e. for the user "johnsmith" on "example.com", the filename path for the application would be at `/home/johnsmith/web/example.com/nodeapp/app.js`. Hestia control panel will automatically stop the NodeJS application when you select a different proxy template for the domain and restart it when you select NodeApp again. Likewise if you delete the domain, Hestia will free the allocated port from the pool of ports on the system and shutdown the NodeJS app prior to deleting the web domain.
 
 ## Subfolder NodeJS Application Hosting
-The HCPP-NodeApp plugin automatically scans the nodeapp folder for any additional PM2 configuration files (*.config.js) in subfolders (excluding node_modules). If it finds any such files, NodeApp plugin will automatically allocate an application port and auto-generate an Nginx include file, defininig the subfolder path, for addendum to whichever backend proxy template is selected. This allows you to automatically mix the hosting of multiple applications under a single domain. For instance, you can select Hestia's default backend template to host a PHP based application in root (such as WordPress), while hosting a NodeJS based applicaiton in a subfolder (such as nodeBB, or Node-RED). Simply create a subfolder within the nodeapp folder and place a valid, unique, *&lt;application name&gt;*.config.js file within the subfolder. You can simply copy the app.config.js file; replace *'app'* with your own application name (be sure to update the package.json's *'main'* property from *'app'* too). Nginx will be configured to serve the NodeJS application under the given subfolder (i.e. www.example.com/nodebb). Note: the *&lt;application name&gt;*.config.js file name must be unique for a given domain. For example, you cannot have two app.config.js files; even if one exists in a subfolder. Instead, i.e. name the second file app2.config.js.
+The HCPP-NodeApp plugin automatically scans the nodeapp folder for any additional PM2 configuration files (*.config.js) in subfolders (excluding node_modules). If it finds any such files, NodeApp plugin will automatically allocate an application port and auto-generate an Nginx include file, defininig the subfolder path, for addendum to whichever backend proxy template is selected. This allows you to automatically mix the hosting of multiple applications under a single domain. For instance, you can select Hestia's default backend template to host a PHP based application in root (such as WordPress), while hosting a NodeJS based applicaiton in a subfolder (such as VitePress, or Node-RED). Simply create a subfolder within the nodeapp folder and place a valid, unique, *&lt;application name&gt;*.config.js file within the subfolder. You can simply copy the app.config.js file; replace *'app'* with your own application name (be sure to update the package.json's *'main'* property from *'app'* too). Nginx will be configured to serve the NodeJS application under the given subfolder (i.e. www.example.com/nodebb). Note: the *&lt;application name&gt;*.config.js file name must be unique for a given domain. For example, you cannot have two app.config.js files; even if one exists in a subfolder. Instead, i.e. name the second file app2.config.js.
+
+Likewise, you can select the backend proxy template `NodeApp` and host two NodeJS applications, one from root, and another in a subfolder. Note that the scanning for *.config.js files, automatic allocation of proxy ports, auto-generation of Nginx addendum files, and automatic startup of NodeJS, only takes place when Nginx services are restarted; you can invoke a restart by selecting/re-selecting a different Proxy Template (see figure 4 above) or using HestiaCP's *`suspend'* and *'unsuspend'* actions. You may use suspend/unsuspend options to populate the NodeApp process list.
 
-Likewise, you can select the backend proxy template `NodeApp` and host two NodeJS applications, one from root, and another in a subfolder. Note that the scanning for *.config.js files, automatic allocation of proxy ports, auto-generation of Nginx addendum files, and automatic startup of NodeJS, only takes place when Nginx services are restarted; you can invoke a restart by selecting/re-selecting a different Proxy Template (see figure 3 above) or using HestiaCP's *`suspend'* and *'unsuspend'* actions.
 
 ## Conclusion
 With the HCPP-NodeApp plugin, you do not need to configure ports, create Ngnix templates, or customize any templates. The plugin will automatically allocate ports for each user account and web domain (as well as clean them up when they are deleted). It will furnish a unique NodeJS instance using an advanced process manager with watch dog, as well as configure Nginx to securely display the app on your designated web domain or domain subfolder (or both). Your web development stack will be able to leverage the latest in NodeJS technology, use websockets, and run multiple users, and web domains all from the Hestia control panel.
@@ -77,9 +74,19 @@ the NodeApp. Developers can hook and implement their own NodeApp using these act
 * **nodeapp_install_dependencies** - *occurs before `"npm install"`, allows filtering the command.*
 * **nodeapp_startup_services** - *occurs before `"pm2 start app.config.js"`, allows filtering the command.*
 * **nodeapp_shutdown_services** - *occurs before `"pm2 delete app.config.js"`, allows filtering the command.*
-* **nodeapp_subfolder_nginx_conf** - *occurs before writing Nginx conf file for subfolder app hosting.*
-* **nodeapp_subfolder_nginx_ssl_conf** - *occurs before writing Nginx SSL conf file for subfolder app hosting.*
+* **nodeapp_write_conf_nodeapp** - *occurs before writing nginx.conf_nodeapp file for app hosting.*
+* **nodeapp_write_ssl_conf_nodeapp** - *occurs before writing nginx.ssl.conf_nodeapp file for app hosting.*
+* **nodeapp_nginx_confs_written** - *occurs after nginx.conf and nginx.ssl.conf have been written.*
 * **nodeapp_resurrect_apps** - *occurs after system reboot and issues the command to restart PM2 apps.*
+* **nodeapp_xpath** - *occurs when viewing the NodeApp process list.*
+* **nodeapp_html** - *occurs when viewing the NodeApp process list.*
+* **nodeapplog_xpath** - *occurs when viewing the NodeApp process log.*
+* **nodeapplog_html** - *occurs when viewing the NodeApp process log.*
+* **nodeapp_maintenance_start** - *occurs before a maintenance event starts.*
+* **nodeapp_maintenance_start** - *occurs after a maintenance event ends.*
+* **nodeapp_update_nodejs** - *occurs when a nodejs version is about to be updated.*
+* **nodeapp_autoupdate** - *occurs daily if hestia autoupdates is enabled; ideal time perform updates (do_maintenance) tasks.*
+
 
 ## Support the creator
 You can help this author's open source development endeavors by donating any amount to Stephen J. Carnam @ Virtuosoft. Your donation, no matter how large or small helps pay for essential time and resources to create MIT and GPL licensed projects that you and the world can benefit from. Click the link below to donate today :)

benchmark

@@ -0,0 +1,34 @@
+#!/bin/bash
+#
+# @author Stephen J. Carnam
+# @license GNU GENERAL PUBLIC LICENSE Version 2
+# @link https://steveorevo.com
+#
+
+# Check if a command is provided
+if [ -z "$1" ]; then
+  echo "Usage: benchmark <command>"
+  exit 1
+fi
+
+# Capture the start time in nanoseconds
+start_time=$(date +%s%N)
+
+# Run the provided command
+"$@"
+
+# Capture the end time in nanoseconds
+end_time=$(date +%s%N)
+
+# Calculate the elapsed time in seconds with fractional seconds
+elapsed_time=$(echo "scale=6; ($end_time - $start_time) / 1000000000" | bc)
+
+# Format the elapsed time
+minutes=$(echo "$elapsed_time / 60" | bc)
+seconds=$(echo "$elapsed_time % 60" | bc)
+
+if (( $(echo "$minutes > 0" | bc -l) )); then
+  printf "Time taken: %d minutes and %.6f seconds\n" "$minutes" "$seconds"
+else
+  printf "Time taken: %.6f seconds\n" "$seconds"
+fi

images/nodeapp-pm2.jpg

@@ -14,7 +14,7 @@ fi
 # apt remove --purge nodejs -y
 
 # Get prerequisites, latest NVM version, and build tools if we need to compile from source
-apt-get install -y curl build-essential gnupg2
+apt-get install -y curl build-essential gnupg2 rsync
 LATEST_VERSION=$(curl -s https://api.github.com/repos/nvm-sh/nvm/releases/latest | grep '"tag_name":' | cut -d '"' -f 4)
 curl -fsSL https://raw.githubusercontent.com/nvm-sh/nvm/${LATEST_VERSION}/install.sh | bash
 source ~/.bashrc
@@ -75,5 +75,29 @@ EOT
 
 fi
 
+# Comment out /root/.bashrc
+BASHRC_FILE="/root/.bashrc"
+
+# Lines to search for
+NVM_LINES=(
+    'export NVM_DIR="$HOME/.nvm"'
+    '[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"'
+    '[ -s "$NVM_DIR/bash_completion" ] && \. "$NVM_DIR/bash_completion"'
+)
+
+# Iterate over each line and comment it out if not already commented
+for line in "${NVM_LINES[@]}"; do
+    # Escape special characters in the line for use in grep and sed
+    escaped_line=$(printf '%s\n' "$line" | sed 's/[.[\*^$(){}?+|]/\\&/g')
+
+    # Check if the line exists and is not already commented
+    if grep -q "$escaped_line" "$BASHRC_FILE" && ! grep -q "# $escaped_line" "$BASHRC_FILE"; then
+        sed -i "s|$escaped_line|# $line|" "$BASHRC_FILE"
+        echo "Commented out: $line"
+    else
+        echo "Line not found or already commented: $line"
+    fi
+done
+
 # Notify installation has finished
 /usr/local/hestia/bin/v-add-user-notification admin NodeApp "<span style=\"font-size:large;color:green;\">&#11042;</span> NodeApp plugin has finished installing."

images/updates.png

@@ -5,6 +5,8 @@
  * @param {*} path - the path to the *.config.js file, contains the user, domain, etc.
  */
 
+const { version } = require('os');
+
 module.exports = function(path) {
     // Get the app name, user, domain, other details given the file path
     const fs = require('fs');
@@ -13,7 +15,7 @@ module.exports = function(path) {
     details._config = parse.pop();
     details._app = details._config.replace('.config.js', '');
     details._domain = parse[4];
-    details.name = details._app + '-' + details._domain;
+    details.name = details._app + ' | ' + details._domain;
     details._user = parse[2];
     details.cwd = path.substr(0, path.length - details._config.length - 1);
     details.script = details.cwd + '/' + details._app + '.js';
@@ -36,6 +38,15 @@ module.exports = function(path) {
     }
     details.interpreter = ver;
 
+    // Get the interpreter version from path
+    let versionMatch = ver.match(/v\d+\.\d+\.\d+/); // Regular expression to match 'v' followed by version numbers
+    if (versionMatch) {
+        let version = versionMatch[0]; // Extract the matched version
+        details.version = version;
+    } else {
+        console.error('Version not found in the path');
+    }
+
     // Pass the allocated port number as a -p argument
     let port = 0;
     let pfile = '/usr/local/hestia/data/hcpp/ports/' + details._user + '/' + details._domain + '.ports';
@@ -56,5 +67,33 @@ module.exports = function(path) {
         details._debugPort = port + 3000;
         details.interpreter_args = '--inspect=' + details._debugPort;
     }
+
+
+    details.linkGlobalModules = function(modules) {
+
+        // Ensure node_modules directory exists
+        const nodeModulesPath = this.cwd + '/node_modules';
+        if (!fs.existsSync(nodeModulesPath)) {
+            fs.mkdirSync(nodeModulesPath);
+        }
+        
+        // Setup nvm, use npm version specified in .nvmrc
+        let cmd = "bash -c 'export NVM_DIR=/opt/nvm && source /opt/nvm/nvm.sh && nvm use " + this.version + " && ";
+        cmd += "cd " + this.cwd + " && ";
+
+        // Link global modules to local node_modules
+        for (let i = 0; i < modules.length; i++) {
+            cmd += "unlink node_modules/" + modules[i] + " > /dev/null 2>&1 ; npm link " + modules[i] + " > /dev/null 2>&1 ; ";
+        }
+        cmd += "'";
+
+        // Update npm links
+        try {
+            const {execSync} = require('child_process');
+            execSync(cmd);
+        } catch (error) {
+            // Eat npm link permissions errors
+        }
+    }
     return details;
 }