You are here:
  • KB Home
  • NodeJS Module Manager Interface Overview
< Back

The NodeJS module manager interface

This interface was created to make managing, monitoring, and uploading custom nodeJs applications to your server easier.
It can be found on the Administrator page under the system integrations submenu.

Modules

Each module represents a standalone nodeJs application.

The CPU and Memory usage of the module is monitored at all times.

You can also see how long the module has been online and how many times it has restarted.

With the action buttons you have access to basic functionalities over the module. For example: Stop, Start, Restart and Delete.
You can also edit the module and view the LOG.

Each module can be reached on this path scheme: https://{{your_server_addreress}}/scripts/{{module_name}}

 

LOG

In the LOG view, you can monitor the specific module’s LOG in real-time.

The color-coded text helps you find errors, system messages, and your own LOG entries.

You can turn  the auto-scrolling on/off in the top right corner.

Once a module is restarted it’s log will be cleared.

 

Editing

In the editing view, you can see the CPU and memory activity from the past 5 minutes on charts.
You can change the icon and placeholder image of the module and the module’s configuration here.

Configuration parameters:

  • Display name: The module’s name, it has to be unique because this will be the route where you can reach your application.
  • Description: The summary of the module (optional).
  • Query params: The query parameters that the widget expects.
  • Absolute path: If the application has a web service you can define the main endpoint here.

This configuration will be necessary for the Editor integration.

You can download the application files of the module with the download button.
You can also download all of the existing modules at once with the main download button in the top right corner.

 

The Main Module

The main module is responsible for managing other modules and the whole PM2 environment.
You cannot edit, stop, or delete this module for the reasons mentioned above.
When restarting this module you will restart the whole PM2 system with all the modules.
The Main modules log is a summary of the whole system.

 

Adding new modules

When adding a new module you have two options, upload your own nodeJs application or choose one from the samples we provide.

Uploading your own application.
You can predefine the configuration parameters for the widget.
You can also load the configuration file from the uploaded application .zip.You can find more information about the guidelines and how to create your own application here.

 

Adding one of our sample applications
You can easily choose and add one of our pre-made sample applications.

Each application has a description of what it does, a version number, and the date of publishing.

Once the module is added you can find information on how to use it on this URL scheme:
https://{{your_server_address}}/scripts/{{module_name}}/howto