Skip to content

Installation

ZorT edited this page Mar 1, 2026 · 5 revisions

Prerequisites

Ensure you have the following installed before proceeding with the installation:

  • Node.js (v14 or higher)
  • Docker
  • npm (Node Package Manager)

Installation

Follow these steps to install and set up NSM:

  1. Clone the Repository

    git clone https://github.com/ZorTik/node-server-manager

    Alternatively, download the latest release from the NSM repository and extract it.

  2. Configure Environment Variables Copy the example environment file and fill in the required values:

    cp .env.example .env

    Open the .env file and provide the necessary configuration values.

  3. Edit Configuration Adjust the default configuration settings in resources/config.yml according to your requirements. You can also override these settings using environment variables. Detailed information about each configuration option is available within the file.

  4. Install Dependencies Install the required Node.js packages:

    npm install
  5. Generate Prisma Client Generate the Prisma client for database interaction:

    npx prisma generate
  6. Sync Database Schema Apply the database schema migrations:

    npx prisma migrate deploy
  7. Build the Project Compile the project for production:

    npm run build

Running

To start the NSM service, use the following command:

npm start

This will launch the NSM server, making it ready to handle requests and manage services dynamically.

Clone this wiki locally