... | @@ -6,7 +6,7 @@ Charts and plots will be visualized with [highcharts](https://www.highcharts.com |
... | @@ -6,7 +6,7 @@ Charts and plots will be visualized with [highcharts](https://www.highcharts.com |
|
|
|
|
|
Documentation for these frameworks can be found directly on their site.
|
|
Documentation for these frameworks can be found directly on their site.
|
|
|
|
|
|
All of these libraries are provided under MIT License and thus free to use in the VM4SEC project.
|
|
All of these libraries are provided under MIT License and thus are free to use in the VM4SEC project.
|
|
|
|
|
|
# Repository organization
|
|
# Repository organization
|
|
Directories and files:
|
|
Directories and files:
|
... | @@ -19,6 +19,7 @@ Directories and files: |
... | @@ -19,6 +19,7 @@ Directories and files: |
|
- `assets` contains artefacts like icons and images that are used within the components.
|
|
- `assets` contains artefacts like icons and images that are used within the components.
|
|
- `apis` contains the API calls to the backend services.
|
|
- `apis` contains the API calls to the backend services.
|
|
- `public` contains the files that are actually visible to everyone with access on the server.
|
|
- `public` contains the files that are actually visible to everyone with access on the server.
|
|
|
|
- `.env-default` contains all environment variables that hold host configurations (e.g., URLS) for each backend service.
|
|
|
|
|
|
# Installation of VM4SEC Dashboard
|
|
# Installation of VM4SEC Dashboard
|
|
- **Step 1**: Clone the latest VM4SEC Dashboard version that can be found in the present Gitlab repository and navigate to the root directory.
|
|
- **Step 1**: Clone the latest VM4SEC Dashboard version that can be found in the present Gitlab repository and navigate to the root directory.
|
... | @@ -26,7 +27,9 @@ Directories and files: |
... | @@ -26,7 +27,9 @@ Directories and files: |
|
```bash
|
|
```bash
|
|
npm install
|
|
npm install
|
|
```
|
|
```
|
|
- **Step 3**: Next, you must create an empty `.env` file in the root directory of the application. Then, copy the contents of the `.env-default` file (also found in root directory) inside the `.env` file. The `.env` file contains all environment variables that hold host configurations for each backend server, so you should modify environment variables accordingly. Remember to restart the application each time you modify this file.
|
|
- **Step 3**: Next, you must create an empty `.env` file in the root directory of the application. Then, copy the contents of the `.env-default` file (also found in root directory) inside the `.env` file.
|
|
|
|
|
|
|
|
**Important Notice:** The `.env` file contains all environment variables that hold host configurations for each backend service (e.g., URLS), so you should modify these environment variables accordingly. Remember to restart the application each time you modify this file.
|
|
- **Step 4**: Finally, you can start the VM4SEC Dashboard server and a web page should open on your favorite browser. Open cmd and run the following command:
|
|
- **Step 4**: Finally, you can start the VM4SEC Dashboard server and a web page should open on your favorite browser. Open cmd and run the following command:
|
|
```bash
|
|
```bash
|
|
npm start
|
|
npm start
|
... | @@ -41,6 +44,7 @@ Alternatively, you can install the VM4SEC Dashboard using Docker. |
... | @@ -41,6 +44,7 @@ Alternatively, you can install the VM4SEC Dashboard using Docker. |
|
```
|
|
```
|
|
cp ./.env-default ./.env
|
|
cp ./.env-default ./.env
|
|
```
|
|
```
|
|
|
|
**Important Notice:** The `.env` file contains all environment variables that hold host configurations for each backend service (e.g., URLS), so you should modify these environment variables accordingly. Remember to restart the application each time you modify this file.
|
|
- **Step 4**: Open cmd and run:
|
|
- **Step 4**: Open cmd and run:
|
|
```
|
|
```
|
|
sudo docker run -it \
|
|
sudo docker run -it \
|
... | | ... | |