ver/1.2

.github/workflows/jest.yml

@@ -13,9 +13,10 @@ jobs:
   test:
     runs-on: ubuntu-latest
     env:
-      DATABASE_URL: 'mysql://test:test@localhost:3306/test'
-      CONFIG_DOCKER_HOST: '///var/run/docker.sock'
-      DEBUG: 'true'
+      DATABASE_URL: "mysql://test:test@localhost:3306/test"
+      CONFIG_DOCKER_HOST: "///var/run/docker.sock"
+      CONFIG_RESOURCES_PATH: "./resources"
+      DEBUG: "true"
     steps:
       - name: Checkout
         uses: actions/checkout@v2
@@ -26,14 +27,20 @@ jobs:
             echo "This PR is from the dev branch. Exiting..."
             exit 0
           fi
+      - name: Prepare resources folder for tests
+        run: |
+          # Create test template folder
+          mkdir -p ./resources/templates/test
+          # Copy test template files to the resources folder
+          cp -r ./dev/templates/test/* ./resources/templates/test/
       - name: Shutdown default MySQL
         run: sudo service mysql stop
       - name: Setup MySQL
         uses: mirromutth/mysql-action@v1.1
         with:
-          mysql database: 'test'
-          mysql user: 'test'
-          mysql password: 'test'
+          mysql database: "test"
+          mysql user: "test"
+          mysql password: "test"
       - name: Install Node.js
         uses: actions/setup-node@v6
         with:
@@ -48,4 +55,4 @@ jobs:
         run: npm test
       - name: Publish Test Summary Results
         run: npx github-actions-ctrf ctrf/ctrf-report.json
-        if: always()
+        if: always()

.github/workflows/push-image.yml

@@ -10,7 +10,7 @@ on:
   workflow_dispatch:
     inputs:
       tag:
-        description: 'Tag to use for the image (optional, defaults to branch name and short SHA)'
+        description: "Tag to use for the image (optional, defaults to branch name and short SHA)"
         required: false
 
 jobs:
@@ -30,20 +30,20 @@ jobs:
         run: |
           IMAGE_OWNER=$(echo "${{ github.repository_owner }}" | tr '[:upper:]' '[:lower:]')
           IMAGE_NAME=ghcr.io/$IMAGE_OWNER/node-server-manager
-          
+
           if [ "${{ github.event_name }}" = "release" ]; then
             TAG=${{ github.event.release.tag_name }}
             echo "IS_RELEASE=true" >> $GITHUB_ENV
-  
+
           elif [ "${{ github.event_name }}" = "workflow_dispatch" ] && [ -n "${{ github.event.inputs.tag }}" ]; then
             TAG=${{ github.event.inputs.tag }}
             echo "IS_RELEASE=true" >> $GITHUB_ENV
-  
+
           else
             TAG=${GITHUB_REF_NAME}-$(echo $GITHUB_SHA | cut -c1-7)
             echo "IS_RELEASE=false" >> $GITHUB_ENV
           fi
-          
+
           echo "IMAGE_NAME=$IMAGE_NAME" >> $GITHUB_ENV
           echo "IMAGE_TAG=$TAG" >> $GITHUB_ENV
 
@@ -66,4 +66,4 @@ jobs:
         if: env.IS_RELEASE == 'true'
         run: |
           docker tag $IMAGE_NAME:$IMAGE_TAG $IMAGE_NAME:latest
-          docker push $IMAGE_NAME:latest
+          docker push $IMAGE_NAME:latest

.gitignore

@@ -131,7 +131,6 @@ dist
 .pnp.*
 
 # Other
-templates
 volumes
 
 # Exclude all addons except the example one

.prettierignore

@@ -0,0 +1,5 @@
+# Ignore artifacts:
+build
+coverage
+dev
+resources

.prettierrc

@@ -0,0 +1 @@
+{}

Dockerfile

@@ -2,10 +2,6 @@ FROM node:22
 
 WORKDIR /data
 
-# Copy addons before install to install dependencies for addons as well
-COPY addons ./addons
-
-COPY installTempDeps.js ./
 COPY package*.json ./
 RUN npm install
 
@@ -23,4 +19,4 @@ COPY index.ts ./
 
 RUN npm run build
 
-CMD npx prisma migrate deploy && npm run start
+CMD npm start

Makefile

@@ -0,0 +1,34 @@
+.PHONY: build test up down restart logs shell ps
+
+ATTACH ?= 0
+
+all: build
+
+build:
+	docker compose build
+
+test:
+ifeq ($(ATTACH),1) # if ATTACH=1, run tests with debugger attached
+	docker compose run --rm -p 9229:9229 nsm \
+            		sh -c 'npm run migrate && node --inspect-brk=0.0.0.0:9229 ./node_modules/.bin/jest --runInBand $(ARGS)'
+else
+	docker compose run --rm nsm npm run test $(ARGS)
+endif
+
+up:
+	docker compose up -d
+
+down:
+	docker compose down
+
+restart:
+	docker compose restart
+
+logs:
+	docker compose logs -f
+
+shell:
+	docker compose exec nsm sh
+
+ps:
+	docker compose ps

README.md

@@ -12,6 +12,7 @@ NSM is a robust service manager built on Docker Engine. Its primary purpose is t
 - **Resources usage management**: NSM provides ability to limit or extend resources limits and view current usage.
 
 ## API Specification
+
 <a href="https://zortik.github.io/nsm-spec/" target="_blank">Specification is hosted on external repository here</a>
 
 ## Prerequisites
@@ -27,35 +28,42 @@ Ensure you have the following installed before proceeding with the installation:
 Follow these steps to install and set up NSM:
 
 1. **Clone the Repository**
+
    ```sh
    git clone https://github.com/ZorTik/node-server-manager
    ```
+
    Alternatively, download the latest release from the [NSM repository](https://github.com/ZorTik/node-server-manager) and extract it.
 
 2. **Configure Environment Variables**
    Copy the example environment file and fill in the required values:
+
    ```sh
    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:
+
    ```sh
    npm install
    ```
 
 5. **Generate Prisma Client**
    Generate the Prisma client for database interaction:
+
    ```sh
    npx prisma generate
    ```
 
 6. **Sync Database Schema**
    Apply the database schema migrations:
+
    ```sh
    npx prisma migrate deploy
    ```

babel.config.js

@@ -1,6 +1,6 @@
 module.exports = {
-    presets: [
-        ['@babel/preset-env', {targets: {node: 'current'}}],
-        '@babel/preset-typescript',
-    ],
-};
+  presets: [
+    ["@babel/preset-env", { targets: { node: "current" } }],
+    "@babel/preset-typescript",
+  ],
+};

dev/config.yml

@@ -0,0 +1,45 @@
+# All values here can be overwritten by environment variables
+# with CONFIG_<key> format.
+
+# ID of this node. Should be unique.
+node_id: "main"
+# Listen port.
+port: 3000
+# Security
+# Supported types: 'none', 'auth_token'
+auth: "none"
+docker_host: "unix:///var/run/docker.sock"
+# Override resources path if needed.
+# By default, an explicit system-specific data path is used.
+# resources_path: '/srv/resources'
+repositories:
+  - id: local
+    type: filesystem
+  - id: dockerhub
+    type: docker-registry
+    puller:
+      registry: "https://index.docker.io/v1/"
+      # optional auth config
+      # auth:
+      #   username: "your_username"
+      #   password: "your_password"
+    templates:
+      - id: redis
+        image: "redis:latest"
+        name: "Redis"
+        description: "Redis template"
+        config:
+          port_range:
+            min: 22222
+            max: 33333
+          meta: { }
+          # Args, and their default values
+          args: { }
+          container:
+            # TODO: port mappings with variables resolving
+            env: { }
+            resources:
+              limits:
+                ram: 512000000
+                cpu: 2
+                disk: 2000000000

dev/templates/minecraft/Dockerfile

@@ -0,0 +1,6 @@
+FROM itzg/minecraft-server
+
+# Optional ones. From build-stage.yml
+
+# port1 port2 port3
+EXPOSE $SERVICE_PORTS

dev/templates/minecraft/build-stage.yml

@@ -0,0 +1,2 @@
+# Build stage args to inject. Use ${} placeholders for args passed in settings.yml.
+buildargs: {}

dev/templates/minecraft/settings.yml

@@ -0,0 +1,21 @@
+name: "Minecraft"
+description: "Minecraft template"
+port_range:
+  min: 22222
+  max: 33333
+meta:
+  internal/stop-command: "stop"
+# Args, and their default values
+args:
+  eula: "TRUE"
+  version: "1.20.4"
+container:
+  env:
+    EULA: "${args.eula}"
+    SERVER_PORT: "${service.port}"
+    VERSION: "${args.version}"
+  resources:
+    limits:
+      ram: 4096000000
+      cpu: 2
+      disk: 2000000000

dev/templates/nginx/Dockerfile

@@ -0,0 +1,6 @@
+FROM nginx
+
+# Optional ones. From build-stage.yml
+
+# port1 port2 port3
+EXPOSE $SERVICE_PORTS

dev/templates/nginx/build-stage.yml

@@ -0,0 +1,2 @@
+# Build stage args to inject. Use ${} placeholders for args passed in settings.yml.
+buildargs: {}

dev/templates/nginx/settings.yml

@@ -0,0 +1,15 @@
+name: "Nginx"
+description: "Nginx template"
+port_range:
+  min: 22222
+  max: 33333
+meta: {}
+# Args, and their default values
+args: {}
+container:
+  env: {}
+  resources:
+    limits:
+      ram: 512000000
+      cpu: 2
+      disk: 2000000000

dev/templates/test/.nsmignore

@@ -0,0 +1,2 @@
+# Define list of ignored files & directories to NOT include in the container,
+# as you would do in .gitignore

dev/templates/test/Dockerfile

@@ -0,0 +1,9 @@
+FROM busybox
+
+# Don't change this!
+WORKDIR /data
+COPY . .
+
+# Optional ones. From build-stage.yml
+
+ENTRYPOINT ["tail", "-f", "/dev/null"]

dev/templates/test/build-stage.yml

@@ -0,0 +1,2 @@
+# Build stage args to inject. Use ${} placeholders for args passed in settings.yml.
+buildargs: {}

dev/templates/test/settings.yml

@@ -0,0 +1,21 @@
+name: "Test"
+description: "A Test template"
+port_range:
+  min: 22222
+  max: 33333
+defaults:
+  ram: 512000000 # bytes
+  cpu: 2 # cores
+  disk: 2000000000 # bytes
+meta:
+  # Stop command to be sent in stop signal endpoint
+  internal/stop-command: "stop"
+# Args, and their default values
+args: {}
+container:
+  env: {}
+  resources:
+    limits:
+      ram: 512000000
+      cpu: 2
+      disk: 2000000000