From ebf443a3204560e96328df13622df00141d88610 Mon Sep 17 00:00:00 2001
From: aninda052 <anindahalder052@gmail.com>
Date: Mon, 9 Oct 2023 13:41:00 +0600
Subject: [PATCH] doc: (server) update doc for elastic stack (#86)

---
 .gitignore                                    |  2 ++
 README.md                                     | 10 ++++++++++
 ...adee2a3b2bd408d90586049413043f9-audit.json | 20 -------------------
 server/EKA-docker/README.md                   |  5 +++--
 server/package.json                           |  3 ++-
 5 files changed, 17 insertions(+), 23 deletions(-)
 delete mode 100644 server/.ef670e866adee2a3b2bd408d90586049413043f9-audit.json

diff --git a/.gitignore b/.gitignore
index a98f883..518ff87 100644
--- a/.gitignore
+++ b/.gitignore
@@ -5,6 +5,7 @@ npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
 lerna-debug.log*
+*-audit.json
 
 # Diagnostic reports (https://nodejs.org/api/report.html)
 report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
@@ -107,3 +108,4 @@ dist
 uploads
 
 build
+
diff --git a/README.md b/README.md
index 7e8d5be..e137480 100644
--- a/README.md
+++ b/README.md
@@ -47,6 +47,16 @@ The client app is based on create-react-app and MUI library. It uses
 socket.io-client and React Context to communicate with the API server and
 display the video content.
 
+### Elastic Stack
+
+Elastic stack is used for monitoring log and api performance. Backend system is not 
+dependent on Elastic Stack meaning `Backend system` can run without `Elastic Stack`.
+
+see `Elastic Stack` documentation [here](server/EKA-docker/README.md)
+
+
+
+
 ## Prerequisites
 
 To get started with MERN Video Streaming, you will need to have the following
diff --git a/server/.ef670e866adee2a3b2bd408d90586049413043f9-audit.json b/server/.ef670e866adee2a3b2bd408d90586049413043f9-audit.json
deleted file mode 100644
index 722ef5b..0000000
--- a/server/.ef670e866adee2a3b2bd408d90586049413043f9-audit.json
+++ /dev/null
@@ -1,20 +0,0 @@
-{
-    "keep": {
-        "days": true,
-        "amount": 14
-    },
-    "auditLog": ".ef670e866adee2a3b2bd408d90586049413043f9-audit.json",
-    "files": [
-        {
-            "date": 1695732103032,
-            "name": "application-2023-09-26-18.log",
-            "hash": "79ee3cf2b1fa330f399d3b775bd859db3a9f62a9af4c9c33bbe786dc0d222457"
-        },
-        {
-            "date": 1695746509756,
-            "name": "application-2023-09-26-22.log",
-            "hash": "90f46d8772b164be1848255e9d234603a4a51516c958579d1c5b901b9e59363e"
-        }
-    ],
-    "hashType": "sha256"
-}
\ No newline at end of file
diff --git a/server/EKA-docker/README.md b/server/EKA-docker/README.md
index 613170d..813a9b5 100644
--- a/server/EKA-docker/README.md
+++ b/server/EKA-docker/README.md
@@ -7,15 +7,16 @@
 
 ## Installation
 
-* create `.env` file and populate all the required environment variable (see `.ent.template` for reference)
+* create `.env` file in `EKA-docker` directory and populate all the required environment variable (see [`.ent.template`](.env.template) for reference)
 
 * build the container 
 
   ```bash
-  docker-compose up --build
+  docker-compose up
   ```
 
 if everything went well, you will find `kibana` running at `http://localhost:5601/`. 
+
 To log into `kibana dashboard` use values of `ELASTICSEARCH_USERNAME` & `ELASTICSEARCH_PASSWORD` of your env variable.
 
 
diff --git a/server/package.json b/server/package.json
index a61a22a..12c76e7 100644
--- a/server/package.json
+++ b/server/package.json
@@ -20,7 +20,8 @@
     "init-directories": "zx scripts/shell-script.mjs",
     "docker-build-and-run": "docker-compose up --build",
     "docker-build": "docker-compose build",
-    "docker": "docker-compose up"
+    "docker": "docker-compose up",
+    "es": "docker-compose -f ./EKA-docker/docker-compose.yml up"
   },
   "keywords": [],
   "author": "",