Skip to content

Commit

Permalink
doc: (server) update doc for elastic stack (foyzulkarim#86)
Browse files Browse the repository at this point in the history
  • Loading branch information
aninda052 committed Oct 9, 2023
1 parent 4292ff2 commit ebf443a
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 23 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -107,3 +108,4 @@ dist
uploads

build

10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
20 changes: 0 additions & 20 deletions server/.ef670e866adee2a3b2bd408d90586049413043f9-audit.json

This file was deleted.

5 changes: 3 additions & 2 deletions server/EKA-docker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand Down
3 changes: 2 additions & 1 deletion server/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "",
Expand Down

0 comments on commit ebf443a

Please sign in to comment.