Merge pull request #78 from MaxxtonGroup/upgrades

MXTS-25998: Upgrades/fixes

Author: rsonke-maxxton

Dockerfile

@@ -1,4 +1,4 @@
-FROM node:9.11.1-alpine
+FROM node:14-alpine
 
 EXPOSE 3000
 WORKDIR /microdocs/microdocs-server/dist
@@ -8,5 +8,7 @@ ADD microdocs-server/config.yml /microdocs/microdocs-server/config.yml
 ADD microdocs-server/dist/ /microdocs/microdocs-server/dist/
 ADD microdocs-ui/dist/ /microdocs/microdocs-ui/dist/
 ARG CLI_VERSION
-RUN echo @maxxton:registry=https://nexus-dev.maxxton.com/repository/npm-group/ > ~/.npmrc && \
-    npm install -g @maxxton/microdocs-cli@$CLI_VERSION
+ARG NPM_TOKEN
+RUN echo -e "@maxxton:registry=https://nexus-mxtf.maxxton.com/repository/npm-group/\n_auth=${NPM_TOKEN}" > ~/.npmrc
+RUN npm install -g @maxxton/microdocs-cli@$CLI_VERSION
+RUN cd /microdocs/microdocs-server/dist/ && npm install

README.md

@@ -29,6 +29,15 @@ To install via Docker run:
 $ docker run --name microdocs -v /some/data/folder:/microdocs/microdocs-server/data -p 3000:3000 -d maxxton/microdocs
 ```
 
+### Build the MicroDocs Docker image
+```
+docker build --no-cache --build-arg=CLI_VERSION='2.0.0' --build-arg NPM_TOKEN={yourtoken} .
+```
+Where yourtoken can be generated as a base64 encoded string of the username and password:
+```
+echo -n 'user:pass' | openssl base64
+```
+
 ### Setup Crawlers
 Crawlers are project and framework specific. Currently only the Spring framework is supported. 
 The setup for each Crawler can be found in their subdirectories

microdocs-server/.npmrc

@@ -1,2 +1 @@
-@maxxton:registry=https://nexus-mxtf.maxxton.com/repository/npm-group/
-
+@maxxton:registry=https://nexus-mxtf.maxxton.com/repository/npm-group/:_authToken=${NPM_TOKEN}

microdocs-server/Dockerfile

@@ -1,4 +1,4 @@
-FROM node:9.11.1-alpine
+FROM node:14-alpine
 
 # Install dependencies
 WORKDIR /app/@maxxton/microdocs-server
@@ -8,4 +8,4 @@ RUN npm install
 
 # Build microdocs-server
 ADD ./microdocs/microdocs-server/gulpfile.js ./microdocs/microdocs-server/build.js ./microdocs/microdocs-server/config.yml ./
-CMD rm -rf ./dist/* && ./node_modules/.bin/gulp watch
+CMD rm -rf ./dist/* && ./node_modules/.bin/gulp watch

microdocs-server/README.md

@@ -2,10 +2,10 @@
 Express server for storing project definitions and check for compatibility problems. 
 
 ## Setup Development
-This project depends on microdocs-core-ts
+This project depends on microdocs-core
 ```
-# link microdocs-core-ts
-cd ../microdocs-core-ts
+# link microdocs-core
+cd ../microdocs-core
 npm link
 
 # init
@@ -14,7 +14,7 @@ npm install
 npm run link
 
 # compile and watch
-gulp
+npm run watch
 ```
 
 

microdocs-server/config.yml

@@ -7,9 +7,9 @@ default:
   viewFolder: views
   dataFolder: data
 
-  application-name: Maxxton 2
-  application-version: 2.0
-  application-description: Maxxton 2 rest api
+  application-name: Maxxton Software
+  application-version: 1.0
+  application-description: Maxxton Software rest api
   application-schema: http
   application-host: localhost:8000
   application-basePath: ''

microdocs-server/package.json

@@ -8,7 +8,10 @@
   },
   "main": "index.js",
   "scripts": {
-    "build": "tsc -p src/tsconfig.json",
+    "build": "npm run clean && npm run build.tsc && npm run build.package",
+    "build.package": "ts-node ./build/build.package.json.ts",
+    "build.tsc": "tsc --project ./src/tsconfig.json",
+    "clean": "ts-node ./build/clean.dist.ts",
     "start": "ts-node src/index.ts",
     "serve": "ts-node src/index.ts",
     "debug": ".nodemon --watch \"src/**\" --ext \"ts,json\" --ignore \"src/**/*.spec.ts\" --exec  --debug-brk \"ts-node src/index.ts\"",
@@ -33,27 +36,27 @@
     "multer": "^1.4.2",
     "node-rest-client": "^3.1.0",
     "node-yaml-config": "0.0.6",
+    "ts-node": "9.1.1",
     "uuid": "^8.3.2",
-    "winston": "^3.3.3",
-    "ts-node": "9.1.1"
+    "winston": "^3.3.3"
   },
   "devDependencies": {
-    "jest": "26.6.3",
-    "ts-jest": "26.5.6",
-    "@types/jest": "26.0.23",
     "@types/body-parser": "0.0.33",
     "@types/express": "^4.0.35",
     "@types/express-handlebars": "0.0.29",
     "@types/handlebars": "^4.0.31",
     "@types/helmet": "0.0.33",
+    "@types/jest": "26.0.23",
     "@types/multer": "0.0.33",
     "@types/node": "^7.0.0",
     "@types/uuid": "^2.0.29",
     "async": "^2.0.1",
     "del": "^2.2.2",
     "gaze": "^1.1.2",
+    "jest": "26.6.3",
     "merge2": "^1.0.2",
     "nodemon": "^1.11.0",
+    "ts-jest": "26.5.6",
     "typescript": "4.2.4",
     "vinyl-paths": "^3.0.1"
   }

microdocs-server/src/app.ts

@@ -8,7 +8,7 @@ import * as exphbs from 'express-handlebars';
 import * as multer from 'multer';
 
 import * as logger from './logger';
-import {yaml} from "./middelware/yaml-parser";
+import {yaml} from "./middleware/yaml-parser";
 import {Config} from "./config";
 import {BaseRoute} from "./routes/route";
 import {ProjectsRoute} from "./routes/projects.route";
@@ -73,7 +73,16 @@ class Server {
     // this.app.use(logger);
 
     // mount helmet
-    this.app.use(helmet());
+    this.app.use(
+      helmet({
+        contentSecurityPolicy: {
+          useDefaults: true,
+          directives: {
+            "script-src": ["'self' 'unsafe-eval'"],
+          }
+        }
+      })
+    );
 
     // mount custom parser
     this.app.use(yaml({

microdocs-server/src/config.ts

@@ -20,6 +20,7 @@ export class Config {
   public static reload() {
     console.info( "load config" );
     Config.config = (yamlConfig as any).load( Config.configFile );
+    console.info(JSON.stringify(Config.config));
   }
 
   /**

microdocs-server/src/index.ts

@@ -1,16 +1,17 @@
 #!/usr/bin/env node
 "use strict";
 
+import { Config } from "./config";
+
 /**
  * @author Steven Hermans
  */
 
-let config = require("./config");
 let app = require("./app");
 let http = require("http");
 
 // get port from environment and store in Express.
-let port = normalizePort(process.env.PORT || config.port || 8000);
+let port = normalizePort(process.env.PORT || Config.get("port") || 8000);
 app.set("port", port);
 
 // create http server