[OGUI-1579] InfoLogger setup documentation updated, npm run simul fixed.

InfoLogger/README.md

@@ -36,7 +36,7 @@ It interfaces with the system using two modes:
 
 ## Requirements
 - `nodejs` >= `16.x`
-- InfoLogger MySQL database for Query mode
+- InfoLogger MariaDB database for Query mode
 - InfoLoggerServer endpoint for Live mode
 
 ## Installation
@@ -47,6 +47,49 @@ It interfaces with the system using two modes:
 5. Start web app: `npm start`
 6. Open browser and navigate to http://localhost:8080
 
+## Development database installation
+In order to run queries in the InfoLogger a MariaDB server is required. To run a local MariaDB server that can easily be updated/wiped/configured you will need Docker installed.
+1. Follow the instructions specific for you platform: [docker desktop install](https://www.docker.com/products/docker-desktop/)
+2. Create a `compose.yaml` file somewhere on your pc with the following content: 
+```
+services:
+  mariadb:
+    image: mariadb
+    restart: unless-stopped
+    ports:
+     - 3306:3306
+    environment:
+      MARIADB_ROOT_PASSWORD: root
+    # (this is just an example, not intended to be a production configuration)
+  phpmyadmin:
+    image: phpmyadmin
+    restart: unless-stopped
+    ports:
+      - 9090:80
+    environment:
+      - PMA_HOST=mariadb
+```
+This will get you a MariaDB server with phpmyadmin.
+Should you ever feel the need to test a specific version of MariaDB then change the image to `mariadb:11.5` where 11.5 is the version. By default the compose.yaml will get you the latest MariaDB image.
+
+3. Execute the following command in the same directory as the compose.yaml file: `docker compose up -d` this will start the containers and the `-d` parameter makes sure you can close your commandline window by running in daemon mode.
+4. You should now be able to visit `http://localhost:9090/` in your browser of choice, enter user and password root to login.
+5. Create the `INFOLOGGER` database by clicking `New` in the phpMyAdmin UI on the left side.
+6. In the phpMyAdmin UI select `SQL` on the top of the page. Then enter the contents of the `InfoLogger/docs/database-specs.sql` file in the field and pressing the `Go` button.
+7. Edit `config.js` to point to your local database: 
+```
+mysql: {
+  host: '127.0.0.1',
+  user: 'root',
+  password: 'root',
+  database: 'INFOLOGGER',
+  port: 3306,
+  timeout: 60000,
+  retryMs: 5000,
+},
+```
+8. Run the InfoLogger and check for the following message in the console: `info: Connection to DB successfully established: 127.0.0.1:3306`
+
 ## Dummy InfoLogger test server
 InfoLoggerServer can be simulated by running `npm run simul`. The dummy server binds `localhost:6102` endpoint.
 ## InfoLogger insights

InfoLogger/package.json

@@ -21,7 +21,7 @@
     "start": "node index.js",
     "test": "npm run eslint && npm run mocha",
     "dev": "nodemon --inspect --watch index.js --watch lib --watch config.js index.js",
-    "simul": "node test/live-simulator/infoLoggerServer.js",
+    "simul": "node test/live-simulator/runInfoLoggerServer.js",
     "eslint": "./node_modules/.bin/eslint --config eslint.config.js lib/ public/",
     "mocha": "mocha --exit $(find test -name 'mocha-*.js')",
     "coverage": "npm run eslint && nyc npm run mocha",

InfoLogger/test/live-simulator/runInfoLoggerServer.js

@@ -0,0 +1,3 @@
+const { createServer } = require('./infoLoggerServer.js');
+
+createServer();