Skip to main content

Node.js Multi-Process

Deploy multi-process Node.js applications on KloudBean for improved performance and scalability.

Overview​

On KloudBean, you get a complete production-ready stack to build and host high-performance Node.js multi-process applications with PM2, with ease and a few simple steps.

You get:

  • Git integration to pull your code on the server
  • SSH access to the server to run commands manually and using ADM tool for quick deployment
  • File Manager access to add, update and manage files with ease
  • PM2 to run multiple processes of your Node.js app

Launching New Node.js Application​

note

If you already have a server and want to launch an app on it, go to Applications → Add Application and add a Node.js app on an existing server.

In this example, we will create a brand new server.

In order to launch your first Node.js app on a new server, navigate to the server provision page:

  1. Select Cloud Provider (your choice)
  2. Select Application (Node.js Multi-Process)
  3. Select Datacenter with nearest location
  4. Add Application Name
  5. Add Server Name
  6. Select Server size depending on needs (for Node.js build minimum recommended size is 2-4GB)

Launch Node.js Multi-Process Application

Click on Launch button and proceed with the payment process (trial or payment).

Once payment is completed, server with Node.js app provisioning will be initiated.

Wait for a while; it will take 5-7 minutes to create your server, configure and deploy a high-performance web stack.

By default, on a new server you will get the following stack versions:

  • Node > 20.X
  • npm > 10.X
  • nvm (latest)
  • MariaDB > 10.6 (optional)

On KloudBean, multi-process Node.js applications are deployed with PM2 (Process Manager 2), a production-ready process manager for Node.js applications that allows you to keep applications alive forever, reload them without downtime, and facilitate common system admin tasks.

Accessing Application Administration​

Once your server is ready, in order to access your Node.js app, select "Apps" from the header menu to go to the Applications page.

On this page, you will see your application in active status.

Application Status

Click on it to navigate to "Application Administration" > "Access" section.

On this section, you will see:

  1. Application default access URL
  2. Server public address to point your custom domain to it

Application Access

Deploying Your Code​

The next step is to deploy your code.

In order to deploy your code, navigate to the "Code Delivery" tab.

Here, on the first tab → "Git deployment":

  1. Click on "Enable Git Integration"
  2. Copy SSH public key and add it to your SCM provider (GitHub, GitLab)

Enable Git Integration

  1. Copy your repo URL and add it here in "Git Repository URL", select branch and "Clone Repository"

Clone Repository

In this example, we're going to deploy an example Node.js app:

[email protected]:jack-kloudbean/node-backend-api.git

Read the detailed guide on connecting Git.

Once the repo is cloned, the next step is to run the deployment. Click on "Pull & Deploy".

Pull & Deploy

Once you click, it will initiate the build process automatically by doing the following at the backend:

Build Process

  • Take latest repo pull
  • Adding bean.config.json to allow running multi-node app through script
  • Setting required Node version
  • Installing packages
  • Making build
  • Initiating PM2 processes

Updating PM2 Script​

In KloudBean, your scripts to run processes through PM2 are handled with the bean.config.json file.

In order to create this file, go to the nodejs-src directory and create this file. If the file already exists, update the content.

Add File Using File Manager​

Add the bean.config.json file using File Manager:

File Manager

Or Using Command Through Shell​

nano /home/admin/hosted-sites/<app_system_user>/nodejs-src/bean.config.json

And add the following content. In this example, we're adding 2 processes:

  • app → frontend
  • api → API backend
{
  "apps": [
    {
      "name": "app",
      "script": "frontend/app.js",
      "out_file": "/home/admin/hosted-sites/kb_soc61a4dlw/app-logs/app.info.log",
      "error_file": "/home/admin/hosted-sites/kb_soc61a4dlw/app-logs/app.error.log",
      "log_date_format": "YYYY-MM-DD HH:mm Z",
      "time": true,
      "env": {
        "PORT": 3110,
        "APP_NAME": "APP"
      }
    },
    {
      "name": "api",
      "script": "api/api.js",
      "out_file": "/home/admin/hosted-sites/kb_soc61a4dlw/app-logs/app.info.log",
      "error_file": "/home/admin/hosted-sites/kb_soc61a4dlw/app-logs/app.error.log",
      "log_date_format": "YYYY-MM-DD HH:mm Z",
      "time": true,
      "env": {
        "PORT": 3111,
        "APP_NAME": "API"
      }
    }
  ]
}

Bean Config

app and api are 2 processes. You can add as many processes as you want by following this same JSON structure.

note

Important: Update the log path as per your app log directory:

  • Info: /home/admin/hosted-sites/<app_system_user>/app-logs/app.info.log
  • Error: /home/admin/hosted-sites/<app_system_user>/app-logs/app.error.log

Updating/Adding Environment (.env) File​

If you need to add or update the .env file, you can access it using File Manager or optionally using shell.

Navigate to the third tab "FileManager" and click "Launch FileManager" button to open it in a new tab.

Once you are in File Manager, in the nodejs-src directory, you can create a new file .env by clicking on "New file" from the left sidebar.

Give the file name and click "Create".

Create .env File

It will open a new file in the editor. Add your required environment variables. For example:

APP_URL=https://nodejs-232200305.kloudbeansite.com
DB_HOST=localhost
DB_NAME=kb_soc61a4dlw
DB_USERNAME=kb_soc61a4dlw
DB_PASSWORD=31vYF9Dc65gHbV742m

In order to get database access credentials, read the detailed guide on Viewing Database Credentials.

Environment Variables

Once updated, click on the "Save" icon on the top right corner of the editor, and it will be saved.

Viewing Build Logs​

Once your application is started, you can access it from the access URL:

"Application Administration" → Access → Access URL

If you are seeing 503, that means your application is not up and has some errors.

In order to view application logs:

  • You can view logs using File Manager
  • Or by SSH into the server

Go to directory: /home/admin/hosted-sites/<app_system_user>/app-logs

note

Important: It is important to check your application logs if your site is responding with a 503 gateway error. It shows that the application is not running.

In this directory, application logs are being added in the following log files:

  • app.info.log → information logs
  • app.error.log → error logs

You can open these files using File Manager to view the errors.

Restarting Node Application​

If you want to restart your Node application, click "Pull & Deploy". It will build and deploy and will also restart your application.

note

With each deployment, the application also gets restarted. If you need to just restart it, you can run a build from "Pull & Deploy" or using the ADM tool.

Deployment Using ADM Tool (Application Deployment Manager)​

Application Deployment Manager (ADM) is one of KloudBean's features that enables you to deploy your app quickly by just executing one command. It supports all Node.js and Python-based applications.

In order to perform deployment using the ADM tool, you have to access your server using shell.

Read the detailed guide on how to SSH server on KloudBean.

Once you are connected to the server, run the following ADM command:

sudo adm

or

sudo adm <app_system_user>

→ to directly execute for the required application.

ADM Command

If you run this command without app_system_user, then you will have to select the app by providing its number in the prompt and click hit enter.

It will start the deployment process with the logs and progress details on the shell screen.

ADM Deployment

note

Information: While executing deployment through ADM, you will see the port as well to get to know on which port the app is running.

Managing PM2 Using Commands​

While your Node app is started successfully with PM2 or may be failing, you can control PM2 using the following PM2 commands:

sudo -u <app_system_user> pm2 status       # to check processes status
sudo -u <app_system_user> pm2 restart app  # to restart process app
sudo -u <app_system_user> pm2 stop api     # to stop process api
sudo -u <app_system_user> pm2 logs         # to view logs
sudo -u <app_system_user> pm2 reload app   # to reload process app (zero-downtime)
sudo -u <app_system_user> pm2 delete app   # to delete process app
sudo -u <app_system_user> pm2 monit        # to monitor processes
note

You can run other PM2-related commands, but make sure to add the correct user with it: -u <app_system_user>

Once your application is live, you can access it using the app access URL followed by each app process name.

In this example:

  • app → https://<app-access-url>/app
  • api → https://<app-access-url>/api

Next Steps​