Added BeSLighthouse deployment in (BeSLab) (#659)

* Update Readme.md

README.md

@@ -1,16 +1,21 @@
 ## BeSLighthouse
+
 Pronounced as "B-e-S Lighthouse", is a dashboard project for visulaizing the security assessment and risk posture of open source projects and ML models tracked by a BeS lab deployment. BeSecure community hosts an instance of BeSLighthouse [here](https://be-secure.github.io/BeSLighthouse/).
 
 ## Getting Started
-BeSLighthouse is a [React](https://react.dev/) based web interface project that expects a BeS lab ecosystem datastore to pull the data and visualize it. The BeSecure community datastore is maintained in GitHub.com under Be-Secure namespace. 
+
+BeSLighthouse is a [React](https://react.dev/) based web interface project that expects a BeS lab ecosystem datastore to pull the data and visualize it. The BeSecure community datastore is maintained in GitHub.com under Be-Secure namespace.
 
 ### Run BeSLighthouse locally
+
 To try out BeSLighthouse on your own machine, clone the latest release tag and set up the datastore.
 
 #### Prerequisites
+
 - Install NodeJS v16.0 or higher
 
 #### Set up datastore
+
 The current version of BeSLighthouse assumes that the lab assets details are stored in a Git repository structure. The [datastore.ts](https://github.com/Be-Secure/BeSLighthouse/blob/main/src/dataStore.ts) file should be edited to point to your lab's datastore repository. The path urls you see now in the file points to the BeSecure community lab datastore. You can create a Git repository structure in your GitHub or GitLab namespace as given below. Then update the path variables in datastore.ts file.
 
     - Be-Secure
@@ -19,8 +24,9 @@ The current version of BeSLighthouse assumes that the lab assets details are sto
         - besecure-ml-assessment-datastore
 
 #### Start BeSLighthouse
+
 - Clone the latest release tag into your local machine
-- Update datastore.ts with the path 
+- Update datastore.ts with the path
 - Build and start the project
 
 ```
@@ -37,34 +43,161 @@ Windows Powershell / CMD
 > npm start
 ```
 
+## Deployment/Upgrade in any BeSLab instance
+
+Follow these steps to deploy or upgrade BeSLighthouse in a BeSLab environment:
+
+### 1. Navigate to the BeSLighthouse installation folder
+
+   Use the following command to navigate to the installation directory:  
+
+   ```bash
+   cd <Path to BeSLighthouse installation folder e.g., /opt>
+   ```
+
+### 2. Download the latest BeSLighthouse release
+
+   Download the latest version of BeSLighthouse from GitHub:  
+
+   ```bash
+   curl -LJO https://github.com/Be-Secure/BeSLighthouse/archive/refs/tags/<beslighthouse-version>.tar.gz
+   ```
+
+   Replace `<beslighthouse-version>` with the desired version.
+
+### 3. Extract the downloaded archive  
+
+   Extract the contents of the downloaded `.tar.gz` file:  
+
+   ```bash
+   tar -xvzf beslighthouse-<beslighthouse-version>.tar.gz
+   ```
+
+### 4. Rename the extracted folder
+
+   Rename the extracted BeSLighthouse folder:  
+
+   ```bash
+   mv BeSLighthouse-<beslighthouse-version> BeSLighthouse
+   ```
+
+### 5. Verify the port configuration in `package.json`
+
+   Ensure that the `PORT=80` is set in the `start` script parameter of the `package.json` file.
+
+### 6. Update `apiDetailsConfig.json`  
+
+   Configure the `src/apiDetailsConfig.json` file according to your requirement.
+
+#### GitHub Configuration
+
+   If you are using **GitHub**, use the following template:
+
+   ```json
+   {
+      "github": {
+         "namespace": "Be-Secure",
+         "branch": "main",
+         "apiUrl": "https://raw.githubusercontent.com",
+         "token": "YOUR_GITHUB_API_TOKEN"
+      },
+      "gitlab": {
+         "namespace": "",
+         "branch": "",
+         "apiUrl": "",
+         "gitLabUrl": "",
+         "token": ""
+      },
+      "activeTool": "github",
+      "version": "0.20.3",
+      "labName": "Be-Secure Community Lab"
+   }
+   ```
+
+#### GitLab Configuration
+
+   If you are using **GitLab**, use the following template:
+
+   ```json
+   {
+      "github": {
+         "namespace": "",
+         "branch": "",
+         "apiUrl": "",
+         "token": ""
+      },
+      "gitlab": {
+         "namespace": "labAdmin",
+         "branch": "main",
+         "apiUrl": "https://gitlab.example.com/api/v4",
+         "gitLabUrl": "https://gitlab.example.com",
+         "token": "YOUR_GITLAB_API_TOKEN"
+      },
+      "activeTool": "gitlab",
+      "version": "0.20.3",
+      "labName": "Be-Secure Community Lab"
+   }
+   ```
+
+**Notes:**
+
+  - Replace `"YOUR_GITHUB_API_TOKEN"` or `"YOUR_GITLAB_API_TOKEN"` with your respective tokens.
+  - Adjust the `namespace`, `branch`, `apiUrl`, and `gitLabUrl` values to match your environment.
+
+For more details on generating API tokens, refer to the GitHub or GitLab documentation.
+
+### 7. Restart the BeSLighthouse service
+
+   Restart the service to apply the changes:  
+
+   ```bash
+   systemctl restart beslighthouse.service
+   ```
+
+### 8. Verify the deployment
+
+   Open your browser and check that BeSLighthouse has been successfully upgraded to the new version.
+
+---
+
+**Note:** Replace `<beslighthouse-version>` with the actual version you are upgrading to.
+
 ## Usage
+
 A BeS lab ecosystem focus on addressing common security requirements of open source projects, ML models and ML datasets. BeSLighthouse is the face of a BeS lab instance. It gives a detailed view of the open source projects, ML models, ML datasets and the vulnerabilities being tracked in the lab.  
 
 ### Projects Of Interest (POI)
+
 Open source projects tracked by the BeS lab is listed in the POI dashboard. The tracking involes forking the open source projects into the Git namespace of the lab and proactively assess each version source code for vulnerabilities. Project details page gives the comprehensive view of the risk posture of the proejct, including the known vulnerabilities.
 
 ### Vulnerabilities Of Interest (VOI)
+
 Known vulnerabilities that are of interest to the BeS lab is listed in the VOI dashboard. The lab may want to share the information about known vulnerabilities and the affected projects within its tracked projects.
 
 ### Models Of Interest (MOI)
+
 Pretrained machine learning models are available in various public platforms that can put to use for many useful usecases. These open source models may contain severe secutiry vulnerabilities. The ML models tracked by the lab is listed in MOI dashboard. Model card (details page) gives a holistic view of the risk posture and the various attack emulation on that particular model.
 
 ### Datasets of Interest (DOI)
+
 Publicly availbable training dataset that are of interest to the BeS lab is listed in the DOI dashboard. Currently not available for public access. This feature is coming soon.
 
 ## Technology Stack
+
 - NodeJS
 - React
 - Typescript
 
 ## Report Issue
+
 BeSLighthouse uses GitHub's integrated issue tracking system to record bugs and feature requests. If you want to raise an issue, please follow the recommendations below:
 
-* Before you log a bug, please search the [issue tracker](https://github.com/Be-Secure/BeSLighthouse/issues) to see if someone has already reported the problem.
-* If the issue doesn't already exist, [create a new issue](https://github.com/Be-Secure/BeSLighthouse/issues/new/choose).
-* Please provide as much information as possible with the issue report.
+- Before you log a bug, please search the [issue tracker](https://github.com/Be-Secure/BeSLighthouse/issues) to see if someone has already reported the problem.
+- If the issue doesn't already exist, [create a new issue](https://github.com/Be-Secure/BeSLighthouse/issues/new/choose).
+- Please provide as much information as possible with the issue report.
 We like to know the BeSLighthouse version you're using.
-* If possible, try to attach the screenshot of the issue.
+- If possible, try to attach the screenshot of the issue.
 
 ## License
-BeSLighthouse is an Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).
+
+BeSLighthouse is an Open Source software released under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0.html).