7 | Figure 1 - NodeApp process list, control, and logs 8 | 9 | Long term support NodeJS versions that are automatically installed with this plugin include: 10 | 11 | * Gallium v16 12 | * Hydrogen v18 13 | * Iron v20 14 | * Jod v22 15 | 16 | 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. 17 | 18 |
19 | 20 | 21 | ## Installation 22 | 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.3** below with the latest release version) to the nodeapp folder: 23 | 24 | ``` 25 | cd /usr/local/hestia/plugins 26 | sudo git clone --branch v2.0.3 https://github.com/virtuosoft-dev/hcpp-nodeapp nodeapp 27 | ``` 28 | 29 | Note: It is important that the destination plugin folder name is `nodeapp`. 30 | 31 | 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. 32 | 33 |
34 | Figure 3 - NodeApp plugin install notification 35 | 36 | 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: 37 | 38 | ``` 39 | cd /usr/local/hestia/plugins/nodeapp 40 | sudo ./install 41 | sudo touch "/usr/local/hestia/data/hcpp/installed/nodeapp" 42 | ``` 43 | 44 | 45 | ## Using NodeApp to Host a NodeJS Website 46 | 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). 47 | 48 |
49 | Figure 4 - Enable Bash for domain 50 | 51 | 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). 52 | 53 |
54 | Figure 5 - Selecting a Proxy Template 55 | 56 | ## Root NodeJS Application Hosting 57 | 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. 58 | 59 | ## Subfolder NodeJS Application Hosting 60 | 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, *<application name>*.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 *<application name>*.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. 61 | 62 | 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. 63 | 64 | 65 | ## Conclusion 66 | 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. 67 | 68 | ## Extending HCPP-NodeApp via Pluginable Actions 69 | The following [hestiacp-pluginable](https://github.com/virtuosoft-dev/hestiacp-pluginable) actions are invoked when using 70 | the NodeApp. Developers can hook and implement their own NodeApp using these actions: 71 | 72 | * **nodeapp_ports_allocated** - *occurs after ports have been allocated for the given domain.* 73 | * **nodeapp_copy_files** - *occurs after include Hello world ExpressJS files are copied.* 74 | * **nodeapp_install_dependencies** - *occurs before `"npm install"`, allows filtering the command.* 75 | * **nodeapp_startup_services** - *occurs before `"pm2 start app.config.js"`, allows filtering the command.* 76 | * **nodeapp_shutdown_services** - *occurs before `"pm2 delete app.config.js"`, allows filtering the command.* 77 | * **nodeapp_write_conf_nodeapp** - *occurs before writing nginx.conf_nodeapp file for app hosting.* 78 | * **nodeapp_write_ssl_conf_nodeapp** - *occurs before writing nginx.ssl.conf_nodeapp file for app hosting.* 79 | * **nodeapp_nginx_confs_written** - *occurs after nginx.conf and nginx.ssl.conf have been written.* 80 | * **nodeapp_resurrect_apps** - *occurs after system reboot and issues the command to restart PM2 apps.* 81 | * **nodeapp_xpath** - *occurs when viewing the NodeApp process list.* 82 | * **nodeapp_html** - *occurs when viewing the NodeApp process list.* 83 | * **nodeapplog_xpath** - *occurs when viewing the NodeApp process log.* 84 | * **nodeapplog_html** - *occurs when viewing the NodeApp process log.* 85 | * **nodeapp_maintenance_start** - *occurs before a maintenance event starts.* 86 | * **nodeapp_maintenance_start** - *occurs after a maintenance event ends.* 87 | * **nodeapp_update_nodejs** - *occurs when a nodejs version is about to be updated.* 88 | * **nodeapp_autoupdate** - *occurs daily if hestia autoupdates is enabled; ideal time perform updates (do_maintenance) tasks.* 89 | 90 | 91 | ## Support the creator 92 | 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 :) 93 |
94 |
95 |
96 | [
Donate to this Project
][KBD] 97 | 98 | 99 |
100 |
101 |
102 |
103 |
104 | [KBD]: https://virtuosoft.com/donate
105 |
106 | https://virtuosoft.com/donate
107 |
--------------------------------------------------------------------------------
/benchmark:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | #
3 | # @author Stephen J. Carnam
4 | # @license GNU GENERAL PUBLIC LICENSE Version 2
5 | # @link https://steveorevo.com
6 | #
7 |
8 | # Check if a command is provided
9 | if [ -z "$1" ]; then
10 | echo "Usage: benchmark Donate to this Project
][KBD] 97 | 98 | 99 |
560 |
';
578 |
579 | }
580 |
581 | // Create a and insert it after the first found node
582 | $fragment = $xpath->document->createDocumentFragment();
583 | $fragment->appendXML($html);
584 | $firstNode->parentNode->insertBefore($fragment, $firstNode->nextSibling);
585 | } else {
586 | $hcpp->log("hcpp-nodeapp was not found in updates");
587 | }
588 |
589 | return $xpath;
590 | }
591 |
592 | /**
593 | * Modify runuser to incorporate NVM
594 | */
595 | public function hcpp_runuser( $args ) {
596 | $cmd = $args[1];
597 | $cmd = 'export NVM_DIR=/opt/nvm && source /opt/nvm/nvm.sh && ' . $cmd;
598 | $args[1] = $cmd;
599 | return $args;
600 | }
601 |
602 | /**
603 | * Check if system has rebooted and restart apps
604 | */
605 | public function hcpp_rebooted() {
606 |
607 | // Wait up to 60 additional seconds for MySQL to start
608 | $i = 0;
609 | while ( $i < 60 ) {
610 | $i++;
611 | $mysql = shell_exec( 'systemctl is-active mysql' );
612 | if ( trim( $mysql ) == 'active' ) {
613 | break;
614 | }
615 | sleep( 1 );
616 | }
617 |
618 | // Restart all PM2 apps for all user accounts
619 | $users = scandir('/home');
620 | global $hcpp;
621 | $cmd = '';
622 | foreach ( $users as $user ) {
623 | // Ignore hidden files/folders and system folders
624 | if ( $user == '.' || $user == '..' || $user == 'lost+found' || $user == 'systemd' ) {
625 | continue;
626 | }
627 |
628 | // Check if the .pm2 folder exists in the user's home directory
629 | if ( is_dir( "/home/$user/.pm2" ) ) {
630 |
631 | // Restart any pm2 processes
632 | $cmd .= 'runuser -s /bin/bash -l ' . $user . ' -c "cd /home/' . $user . ' && ';
633 | $cmd .= 'export NVM_DIR=/opt/nvm && source /opt/nvm/nvm.sh && pm2 resurrect"' . "\n";
634 | }
635 | }
636 | $cmd = $hcpp->do_action( 'nodeapp_resurrect_apps', $cmd );
637 | if ( trim( $cmd ) != '' ) {
638 | $hcpp->log( shell_exec( $cmd ) );
639 | }
640 | }
641 |
642 | /**
643 | * Add the PM2 process list button to the HestiaCP UI, and restart proxy on modified nginx config files
644 | */
645 | public function hcpp_list_web_xpath( $xpath ) {
646 |
647 | // Check that user has bash shell access needed for PM2
648 | global $hcpp;
649 | $username = $_SESSION["user"];
650 | if ($_SESSION["look"] != "") {
651 | $username = $_SESSION["look"];
652 | }
653 | $detail = $hcpp->run( "v-list-user $username json" );
654 | if ( isset( $detail[$username]['SHELL'] ) && $detail[$username]['SHELL'] == 'bash' ) {
655 | // Locate the 'Add Web Domain' button
656 | $addWebButton = $xpath->query( "//a[@href='/add/web/']" )->item(0);
657 |
658 | if ( $addWebButton ) {
659 |
660 | // Create a new button element
661 | $newButton = $xpath->document->createElement( 'a' );
662 | $newButton->setAttribute( 'href', '?p=nodeapp' );
663 | $newButton->setAttribute( 'class', 'button button-secondary' );
664 | $newButton->setAttribute( 'title', 'NodaApps' );
665 |
666 | // Create the icon element
667 | $icon = $xpath->document->createElement('span', '⬢');
668 | $icon->setAttribute('style', 'font-size:x-large;color:green;margin:-2px 4px 0 0;');
669 |
670 | // Create the text node
671 | $text = $xpath->document->createTextNode( 'NodeApps' );
672 |
673 | // Append the icon and text to the new button
674 | $newButton->appendChild( $icon );
675 | $newButton->appendChild( $text );
676 |
677 | // Insert the new button next to the existing one
678 | $addWebButton->parentNode->insertBefore( $newButton, $addWebButton->nextSibling );
679 | }
680 | }
681 | if ( file_exists( "/tmp/nodeapp_nginx_modified" ) ) {
682 | $hcpp->run( "v-invoke-plugin nodeapp_nginx_modified" );
683 | }
684 | return $xpath;
685 | }
686 |
687 | /**
688 | * Restart the PM2 apps for the given user by ids.
689 | *
690 | * @param array $pm2_ids The list of PM2 process ids to restart
691 | * @param string $user The username to restart the PM2 processes for or the current HestiaCP user if not provided
692 | */
693 | public function restart_pm2_ids( $pm2_ids, $user = '""' ) {
694 | if ( $user == '""' && isset( $_SESSION ) ) {
695 | $user = $_SESSION['user'];
696 | if ( $_SESSION['look'] != '' ) {
697 | $user = $_SESSION['look'];
698 | }
699 | }
700 | global $hcpp;
701 | $hcpp->log( 'nodeapp restart_pm2_ids for user: ' . $user );
702 | $hcpp->log( $pm2_ids );
703 | $pm2_ids = escapeshellarg( json_encode( $pm2_ids ) );
704 | $hcpp->run("v-invoke-plugin nodeapp_restart_pm2_ids " . $user . ' ' . $pm2_ids );
705 | }
706 |
707 | /**
708 | * Scan the nodeapp folder for .config.js files and start the app for each
709 | */
710 | public function startup_apps( $nodeapp_folder, $inc_root = true ) {
711 | global $hcpp;
712 | $parse = explode( '/', $nodeapp_folder );
713 | $user = $parse[2];
714 | $domain = $parse[4];
715 | $files = $this->get_config_files( $nodeapp_folder );
716 | $cmd = 'cd "' . $nodeapp_folder . '" ';
717 | foreach($files as $file) {
718 |
719 | // Skip the root app if inc_root is false
720 | if ( $inc_root == false ) {
721 | $subfolder = str_replace( "$nodeapp_folder/", '', $file );
722 | if ( strpos( $subfolder, '/' ) == false) continue;
723 | }
724 |
725 | // Add app to startup
726 | $cmd .= "; pm2 start $file ";
727 | }
728 |
729 |
730 | if ( strpos( $cmd, '; pm2 start ' ) ) {
731 | $cmd .= '; pm2 save --force ';
732 | $args = [
733 | 'user' => $user,
734 | 'domain' => $domain,
735 | 'cmd' => $cmd
736 | ];
737 |
738 | // Run the command to start all the apps
739 | $args = $hcpp->do_action( 'nodeapp_startup_services', $args );
740 | $hcpp->runuser( $user, $args['cmd'] );
741 | }
742 | }
743 |
744 | /**
745 | * Stop the PM2 apps for the given user by ids.
746 | *
747 | * @param array $pm2_ids The list of PM2 process ids to stop
748 | * @param string $user The username to stop the PM2 processes for or the current HestiaCP user if not provided
749 | */
750 | public function stop_pm2_ids( $pm2_ids, $user = '""' ) {
751 | if ( $user == '""' && isset( $_SESSION ) ) {
752 | $user = $_SESSION['user'];
753 | if ( $_SESSION['look'] != '' ) {
754 | $user = $_SESSION['look'];
755 | }
756 | }
757 | global $hcpp;
758 | $hcpp->log( 'nodeapp stop_pm2_ids for user: ' . $user );
759 | $hcpp->log( $pm2_ids );
760 | $pm2_ids = escapeshellarg( json_encode( $pm2_ids ) );
761 | $hcpp->run("v-invoke-plugin nodeapp_stop_pm2_ids " . $user . ' ' . $pm2_ids );
762 | }
763 |
764 | /**
765 | * Gather list of all running apps to delete and construct shutdown command,
766 | * instead of pm2 delete all; delete each one individually as filters may
767 | * alter the behavior to keep user and select domain apps running.
768 | */
769 | public function shutdown_apps( $nodeapp_folder ) {
770 | global $hcpp;
771 | $parse = explode( '/', $nodeapp_folder );
772 | $user = $parse[2];
773 | $domain = $parse[4];
774 |
775 | // Get list of apps to delete
776 | $cmd = 'pm2 ls | grep "' . $domain . '"';
777 | $lines = $hcpp->runuser( $user, $cmd );
778 | $lines = explode( "\n", $lines );
779 | $cmd = 'cd "' . $nodeapp_folder . '" ';
780 | foreach( $lines as $l ) {
781 | if ( strpos( $l, '-' . $domain ) === false ) continue;
782 | $app = $hcpp->getRightMost( $hcpp->getLeftMost( $l, '-' ), ' ' );
783 | $app = $app . '-' . $domain;
784 |
785 | // Add app to shutdown by name
786 | $cmd .= "; pm2 delete $app ";
787 | }
788 | if ( strpos( $cmd, '; pm2 delete ' ) ) {
789 | $cmd .= '; pm2 save --force ';
790 | $args = [
791 | 'user' => $user,
792 | 'domain' => $domain,
793 | 'cmd' => $cmd
794 | ];
795 |
796 | // Run the command to shutdown all the apps
797 | $args = $hcpp->do_action( 'nodeapp_shutdown_services', $args );
798 | $hcpp->runuser( $user, $args['cmd'] );
799 | }
800 | }
801 |
802 | /**
803 | * Update all NVM managed NodeJS versions and global packages;
804 | * gracefully stop all running PM2 apps using the major version,
805 | * update NodeJS, and restart the stopped apps for each user.
806 | */
807 | public function update_all() {
808 |
809 | // Get list of new versions
810 | global $hcpp;
811 | $versions = $this->get_versions();
812 | $updates = [];
813 | foreach( $versions as $v ) {
814 |
815 | // Find any nodejs versions that need to be updated
816 | if ( $v['installed'] != $v['latest'] ) {
817 | $updates[] = $v;
818 | $majors[] = $hcpp->getLeftMost( $v['installed'], '.' );
819 | }
820 | }
821 |
822 | // Perform maintenance only if updates are available
823 | if ( count( $updates ) == 0 ) {
824 | return;
825 | }
826 |
827 | // Perform the maintenance tasks
828 | $this->do_maintenance( function( $stopped ) use ( $hcpp, $updates ) {
829 | // Update NodeJS, npm, and re-install global packages
830 | foreach( $updates as $v ) {
831 | $cmd = 'nvm install ' . $v['latest'] . ' && nvm use ' . $v['latest'] . ' && npm install -g npm';
832 | $cmd .= ' && nvm reinstall-packages ' . $v['installed'];
833 | $cmd .= ' && nvm uninstall ' . $v['installed'];
834 | $cmd = $hcpp->do_action( 'nodeapp_update_nodejs', $cmd );
835 | $hcpp->runuser( '', $cmd );
836 | }
837 | }, $majors );
838 | }
839 |
840 | /**
841 | * Update the nginx config files for the given user and domain
842 | */
843 | public function update_nginx_files( $args ) {
844 | global $hcpp;
845 | $user = $args[0];
846 | $domain = $args[1];
847 | $nodeapp_folder = "/home/$user/web/$domain/nodeapp";
848 | if ( is_dir( $nodeapp_folder) ) {
849 | $this->generate_nginx_files( $nodeapp_folder, true );
850 | }
851 | }
852 |
853 | /**
854 | * On proxy template change, copy basic nodeapp, allocate ports, and start apps
855 | */
856 | public function v_change_web_domain_proxy_tpl( $args ) {
857 | global $hcpp;
858 | $user = $args[0];
859 | $domain = $args[1];
860 | $proxy = $args[2];
861 | $nodeapp_folder = "/home/$user/web/$domain/nodeapp";
862 |
863 | if ( !is_dir( $nodeapp_folder) && $proxy == 'NodeApp' ) {
864 |
865 | // Copy initial nodeapp folder
866 | $hcpp->copy_folder( __DIR__ . '/nodeapp', $nodeapp_folder, $user );
867 | $args = [
868 | 'user' => $user,
869 | 'domain' => $domain,
870 | 'proxy' => $proxy,
871 | 'nodeapp_folder' => $nodeapp_folder
872 | ];
873 | $args = $hcpp->do_action( 'nodeapp_copy_files', $args );
874 | $nodeapp_folder = $args['nodeapp_folder'];
875 | chmod( $nodeapp_folder, 0755 );
876 |
877 | // Install dependencies
878 | $cmd = 'cd "' . $nodeapp_folder . '" && npm install';
879 | $args['cmd'] = $cmd;
880 | $args = $hcpp->do_action( 'nodeapp_install_dependencies', $args );
881 | $hcpp->runuser( $user, $args['cmd'] );
882 | }
883 |
884 | // Shutdown stray apps and startup root and/or subfolder apps
885 | $this->shutdown_apps( $nodeapp_folder );
886 | $this->allocate_ports( $nodeapp_folder );
887 | $this->generate_nginx_files( $nodeapp_folder, ($proxy == 'NodeApp') );
888 | $this->startup_apps( $nodeapp_folder, ($proxy == 'NodeApp') );
889 | }
890 |
891 | /**
892 | * On domain delete, shutdown apps
893 | */
894 | public function v_delete_web_domain_backend( $args ) {
895 | global $hcpp;
896 | $user = $args[0];
897 | $domain = $args[1];
898 | $nodeapp_folder = "/home/$user/web/$domain/nodeapp";
899 | $this->shutdown_apps( $nodeapp_folder );
900 | unlink( "/usr/local/hestia/data/hcpp/ports/$user/$domain.ports" );
901 | }
902 |
903 | /**
904 | * Rebuild the nginx config files for the given user and domain
905 | */
906 | public function v_rebuild_web_domain( $args ) {
907 | global $hcpp;
908 | $user = $args[0];
909 | $domain = $args[1];
910 | $nodeapp_folder = "/home/$user/web/$domain/nodeapp";
911 | if ( is_dir( $nodeapp_folder) ) {
912 | $this->generate_nginx_files( $nodeapp_folder, true );
913 | }
914 | return $args;
915 | }
916 |
917 | /**
918 | * Notify of any changes to the nginx config files
919 | */
920 | public function v_restart_proxy( $args ) {
921 | if ( file_exists( '/tmp/nodeapp_nginx_modified' ) ) {
922 | $this->do_nginx_modified( false );
923 | }
924 | return $args;
925 | }
926 |
927 | /**
928 | * On domain suspend, shutdown apps
929 | */
930 | public function v_suspend_web_domain( $args ) {
931 | global $hcpp;
932 | $user = $args[0];
933 | $domain = $args[1];
934 | $nodeapp_folder = "/home/$user/web/$domain/nodeapp";
935 |
936 | // Remove prior nginx config files; duplicate location "/" will cause nginx to fail
937 | if ( file_exists( "/home/$user/conf/web/$domain/nginx.ssl.conf_nodeapp" ) ) {
938 | unlink( "/home/$user/conf/web/$domain/nginx.ssl.conf_nodeapp" );
939 | }
940 | if ( file_exists( "/home/$user/conf/web/$domain/nginx.conf_nodeapp" ) ) {
941 | unlink( "/home/$user/conf/web/$domain/nginx.conf_nodeapp" );
942 | }
943 | $this->shutdown_apps( $nodeapp_folder );
944 | return $args;
945 | }
946 |
947 | /**
948 | * On domain unsuspend, startup apps
949 | */
950 | public function v_unsuspend_domain( $args ) {
951 | global $hcpp;
952 | $user = $args[0];
953 | $domain = $args[1];
954 | $nodeapp_folder = "/home/$user/web/$domain/nodeapp";
955 | if ( is_dir( $nodeapp_folder) ) {
956 | $proxy = $hcpp->run("v-list-web-domain $user $domain json");
957 | if ( $proxy != NULL ) {
958 | $proxy = $proxy[$domain]["PROXY"];
959 | $this->allocate_ports( $nodeapp_folder );
960 | $this->generate_nginx_files( $nodeapp_folder, ( $proxy == "NodeApp" ) );
961 | $this->startup_apps( $nodeapp_folder, ( $proxy == "NodeApp" ) );
962 | }
963 | }
964 | return $args;
965 | }
966 |
967 | /**
968 | * Check daily to update our NVM managed and installed NodeJS versions global packages.
969 | */
970 | public function v_update_sys_queue( $args ) {
971 | global $hcpp;
972 | if ( ! (isset( $args[0] ) && trim( $args[0] ) == 'daily') ) return $args;
973 | if ( strpos( $hcpp->run('v-list-sys-hestia-autoupdate'), 'Enabled') == false ) return $args;
974 | $this->update_all();
975 | $hcpp->do_action( 'nodeapp_autoupdate' );
976 | return $args;
977 | }
978 | }
979 | global $hcpp;
980 | $hcpp->register_plugin( NodeApp::class );
981 | }
--------------------------------------------------------------------------------
/nodeapp/.nvmrc:
--------------------------------------------------------------------------------
1 | v22
--------------------------------------------------------------------------------
/nodeapp/.restart/restart:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/virtuosoft-dev/hcpp-nodeapp/8f2ec34b16be83a5291d653d30df2e9dbba2cc81/nodeapp/.restart/restart
--------------------------------------------------------------------------------
/nodeapp/README.md:
--------------------------------------------------------------------------------
1 | # Hello world!
2 | This is a basic NodeJS web server application, Hello world example from
3 | https://expressjs.com/en/starter/hello-world.html. See the source code in `app.js` for details.
4 |
5 | The application is managed under [PM2 (Process Manager 2)](https://pm2.keymetrics.io). You can run or stop running this application using the following commands from the nodeapp folder:
6 |
7 | ```
8 | pm2 start app.config.js
9 | ```
10 | and
11 | ```
12 | pm2 delete app.config.js
13 | ```
14 |
15 | PM2 features an auto-restart mechanism that you can activate by simply changing a file in the .restart subfolder. For example, you can restart the app.js application with:
16 |
17 | ```
18 | touch .restart/restart
19 | ```
20 |
21 | You can change the version of the NodeJS runtime engine by supplying a complete or partial version number in the file `.nvmrc` (i.e. "v18" or "current" for the latest NodeJS version). Supported NodeJS versions are:
22 |
23 | ```
24 | v16
25 | v18
26 | v20
27 | v22
28 | ```
29 |
30 | ## Create Project
31 | You can create your own project by simply renaming the app.js and app.config.js file; change 'app' to your own project. Don't forget to update the package.json's `main` property from 'app' to your own project's name.
32 |
--------------------------------------------------------------------------------
/nodeapp/app.config.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Get compatible PM2 app config object with automatic support for .nvmrc,
3 | * port allocation, and debug mode.
4 | */
5 | module.exports = {
6 | apps: (function() {
7 | let nodeapp = require('/usr/local/hestia/plugins/nodeapp/nodeapp.js')(__filename);
8 | return [nodeapp];
9 | })()
10 | }
11 |
--------------------------------------------------------------------------------
/nodeapp/app.js:
--------------------------------------------------------------------------------
1 | /**
2 | * A simple Hello World! Node.js application that listens
3 | * on the port number specified in the command line.
4 | */
5 |
6 | const express = require('express')
7 | const app = express()
8 |
9 | // Get the port number from the command line's -p argument
10 | let argv = require('minimist')(process.argv.slice(2));
11 | let port = argv.p || 0;
12 | if (port == 0) {
13 | console.log("Port number is not specified");
14 | process.exit(1);
15 | }
16 |
17 | app.get('*', (req, res) => {
18 | res.send('Hello World!');
19 | });
20 |
21 | app.listen(port, () => {
22 | console.log(`Example app listening on port ${port}`);
23 | });
24 |
--------------------------------------------------------------------------------
/nodeapp/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "app",
3 | "version": "1.0.0",
4 | "description": "Hello world example Express app.",
5 | "main": "app.js",
6 | "author": "",
7 | "license": "ISC",
8 | "dependencies": {
9 | "express": "^4.18.2",
10 | "minimist": "^1.2.7"
11 | }
12 | }
--------------------------------------------------------------------------------
/nodeapp_debounce.sh:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 | LOCKFILE="/tmp/nodeapp_debounce.lock"
3 | TIMEOUT=5
4 |
5 | # Check if lockfile exists
6 | if [ -e "$LOCKFILE" ]; then
7 | touch "$LOCKFILE" # Update lockfile timestamp
8 | exit 1
9 | fi
10 |
11 | # Create lockfile
12 | touch "$LOCKFILE"
13 |
14 | # Ensure lockfile is removed on script exit
15 | trap 'rm -f "$LOCKFILE"' EXIT
16 |
17 | # Wait until the lockfile is $TIMEOUT seconds old
18 | while [ $(( $(date +%s) - $(stat -c %Y "$LOCKFILE") )) -lt $TIMEOUT ]; do
19 | sleep 1
20 | done
21 |
22 | # Your script logic goes here
23 | /usr/local/hestia/bin/v-invoke-plugin nodeapp_debounce
24 |
25 | # Lockfile will be removed automatically due to trap
26 | exit 0
27 |
28 |
--------------------------------------------------------------------------------
/pages/nodeapp.php:
--------------------------------------------------------------------------------
1 | log( $_REQUEST );
3 |
4 | // Handle actions
5 | if ( isset( $_REQUEST['action'] ) ) {
6 | $action = $_REQUEST['action'];
7 | if ( isset($_REQUEST['pm2_id']) ) {
8 | $pm2_ids = [$_REQUEST['pm2_id']];
9 | } elseif ( isset($_REQUEST['pm2_ids']) ) {
10 | $pm2_ids = $_REQUEST['pm2_ids'];
11 | } else {
12 | $pm2_ids = [];
13 | }
14 | if ( $action == 'start' || $action == 'restart' ) {
15 | $hcpp->nodeapp->restart_pm2_ids( $pm2_ids );
16 | }elseif ( $action == 'stop' ) {
17 | $hcpp->nodeapp->stop_pm2_ids( $pm2_ids );
18 | }
19 | }
20 | ?>
21 |
22 |
46 |
47 |
561 |
562 |
565 | ↳
563 | nvm-nodejs-v' . $major . '
564 |
566 |
567 | NodeJS v' . $major . ' runtime ' . $notice . '
568 |
569 |
570 |
571 | ' . $installed . ' (' . $arch . ')
572 |
573 |
574 |
575 | ' . $icon . '
576 |
577 |
48 |
186 |
202 |
--------------------------------------------------------------------------------
/pages/nodeapplog.php:
--------------------------------------------------------------------------------
1 |
2 |
14 |
15 |
49 |
181 | nodeapp->delete_pm2_ids( $removed_ids );
184 | ?>
185 |
50 |
61 |
62 | nodeapp->get_pm2_list();
65 | $i = 0;
66 | $removed_apps = '';
67 | $removed_ids = [];
68 | foreach( $list as $app ){
69 | $hcpp->log( $app );
70 | $pm_exec_path = $app['pm2_env']['pm_exec_path'];
71 | $name = $app['name'];
72 | $pm2_id = $app['pm_id'];
73 | if ( !file_exists( $pm_exec_path) ) {
74 | $removed_apps .= "
51 |
52 |
53 | Name | Domain
54 |
55 | NodeJS
56 | Restarts
57 | Uptime
58 | CPU
59 | Memory
60 | $name was removed; missing $pm_exec_path.
"; 75 | $removed_ids[] = $pm2_id; 76 | $hcpp->log("$name was removed; missing $pm_exec_path."); 77 | continue; 78 | } 79 | $i++; 80 | $restarts = $app['pm2_env']['restart_time']; 81 | $version = 'v' . $app['pm2_env']['node_version']; 82 | 83 | // Calculate uptime 84 | $pm_uptime = $app['pm2_env']['pm_uptime']; 85 | $uptime_seconds = (time() * 1000 - $pm_uptime) / 1000; 86 | $days = floor($uptime_seconds / (24 * 3600)); 87 | $uptime_seconds %= (24 * 3600); 88 | $hours = floor($uptime_seconds / 3600); 89 | $uptime_seconds %= 3600; 90 | $minutes = floor($uptime_seconds / 60); 91 | if ( $days > 0 ) { 92 | $uptime = $days . ' days'; 93 | } else if ( $hours > 0 ) { 94 | $uptime = $hours . ' hours'; 95 | } else { 96 | $uptime = $minutes . ' minutes'; 97 | } 98 | $status = $app['pm2_env']['status']; 99 | if ( $status == 'online' ) { 100 | $status_class = 'fas fa-circle-check icon-green u-mr5'; 101 | } else { 102 | $status_class = 'fas fa-circle-minus icon-red u-mr5'; 103 | $uptime = $status; 104 | } 105 | 106 | // Calculate memory and cpu 107 | $memory = round($app['monit']['memory'] / (1024 * 1024), 1) . ' MB'; 108 | $cpu = round($app['monit']['cpu'], 1); 109 | ?> 110 | 111 |
112 |
177 |
180 |
113 |
118 |
114 |
115 |
116 |
117 |
119 |
120 |
121 |
122 |
123 |
124 |
125 |
126 |
156 | -
127 |
- 128 | 129 | 130 | 131 | 132 | 133 | 134 |
- 135 | 136 | 137 | 138 | 139 | 140 |
- 141 | 142 | 143 | 144 | 145 | 146 | 147 |
- 148 | 149 | 150 | 151 | 152 | 153 | 154 |
157 |
158 |
159 |
160 |
161 |
162 |
163 |
164 |
165 |
166 |
167 |
168 |
169 |
170 | %
171 |
172 |
173 |
174 |
175 |
176 | 186 |
187 |
188 |
193 |
196 |
201 |
189 |
192 | Removed Missing NodeApp
190 | 191 |
16 |
22 |
23 |
30 |
--------------------------------------------------------------------------------
/plugin.php:
--------------------------------------------------------------------------------
1 | register_install_script( dirname(__FILE__) . '/install' );
15 | $hcpp->register_uninstall_script( dirname(__FILE__) . '/uninstall' );
16 |
--------------------------------------------------------------------------------
/uninstall:
--------------------------------------------------------------------------------
1 | #!/bin/bash
2 |
3 | # Remove NodeJS, NVM, PM2, and grunt
4 | rm -rf /opt/nvm
5 |
6 | # Update global bash.bashrc
7 | sed '/^# begin hcpp-nodeapp$/,/^# end hcpp-nodeapp$/d' /etc/bash.bashrc > temp.txt && mv temp.txt /etc/bash.bashrc
8 |
9 | ############################################
10 | # Uninstall templates
11 | ############################################
12 | rm -f /usr/local/hestia/data/templates/web/nginx/NodeApp.tpl
13 | rm -f /usr/local/hestia/data/templates/web/nginx/NodeApp.stpl
14 |
--------------------------------------------------------------------------------