Skip to content

Installation

TekMonks edited this page Mar 11, 2020 · 5 revisions

System Requirements

Minimum recommended system requirements based on medium load - 8 GB RAM, 2 Cores, 5 GB disk space assuming weekly log rotation.

Operating systems supported: CentOS, Windows Server, RHEL, and Ubuntu


Basic Installation

Step 1 Download and install the node.js runtime from https://nodejs.org/en/download/. LTS version is recommended. Make sure node is properly installed by issuing this command from a command window node -v. The output should show node version.

Step 2 Install the GIT client for your OS and ensure it is on the path for cmd.exe (Windows) or bash (Linux). Make sure GIT is installed properly by issuing this command from a command window git --version. The output should show GIT version.

Step 3 Download the Monkshu app installer from the links below and place it in the directory you'd like to install to.
Windows: https://raw.githubusercontent.com/TekMonksGitHub/monkshu/master/installApp.bat
Linux: https://raw.githubusercontent.com/TekMonksGitHub/monkshu/master/installApp.sh

Step 4 Run this command to install ./installApp.sh apiboss (Linux) or installApp.bat apiboss (Windows).

Step 5 Start the server using either ./apiboss.sh or apiboss.bat depending on the OS.

Step 6 Optionally, for a vertical cluster, you can modify these files <apiboss>/backend/server/conf/cluster.json and <apiboss>/frontend/server/conf/cluster.json to adjust the number of workers.


HA Setup for Horizontal Cluster

Step 1 Follow same steps as above for the HA nodes

Step 2 A load balancer must be added in front to balance the APIBoss nodes. We have tested NGINX as the HTTP balancer - using the instructions on this URL - https://nginx.org/en/docs/http/load_balancing.html

The diagram below illustrates the HA deployment pattern.

ASB HA Patterns


Clone this wiki locally