GITBOOK-566: No subject

Author: Whitespots

README.md

@@ -4,14 +4,12 @@ description: Welcome to the Whitespots Wiki!
 
 # Home
 
-Whitespots specializes in application security, providing three core products to help you secure your applications: **Auditor**, **AppSec Portal, Security Pipelines** and **Requirement Generator**.
+Whitespots provides 2 core products to help you with securing your applications: **Auditor** and **AppSec Portal**.
 
 #### Quick overview
 
-* [**Auditor**](broken-reference) is an application that integrates diverse security tools for the analysis of users' products. Users can input details about their products, choose a sequence of scanners for analysis, and receive comprehensive security and vulnerability reports.
-* [**AppSec Portal**](broken-reference) is an application security platform that lets you integrate your security scanners with our system to help you visibly and automatic verify vulnerabilities and clean up duplicates.
-* [**Security Pipelines**](broken-reference) is a self-hosted solution that combines more than 25 open source scanners into a single framework to scan for different classes of vulnerabilities in your applications.
-* [**Requirement Generator** ](broken-reference)generates security requirements based on your services functionality to help you ensure security from the start.
+* [**Auditor**](broken-reference) is an application that integrates diverse security tools for the analysis of users' products. This tool is used as a component of AppSec Portal to discover vulnerabilities using 20+ scanners. It works like a CI platform and sends reports to AppSec portal.
+* [**AppSec Portal**](broken-reference) is an application security platform that provides you an overview on your security state, automatically verifies vulnerabilities, removes duplicates, changes severities, closes resolved issues and more.
 
 **Support**
 

SUMMARY.md

@@ -4,9 +4,9 @@
 
 ## 🔦 Auditor
 
-* [📥 Install](auditor/install/README.md)
-  * [Installation](auditor/install/installation.md)
-  * [Update](auditor/install/update.md)
+* [📥 Deployment](auditor/deployment/README.md)
+  * [Installation](auditor/deployment/installation.md)
+  * [Update](auditor/deployment/update.md)
 * [🎯 Features](auditor/features.md)
 * [⚙️ Settings](auditor/settings/README.md)
   * [AppSec Portal cooperation](auditor/settings/appsec-portal-cooperation.md)
@@ -26,15 +26,15 @@
 
 ## 🖥️ AppSec Portal
 
-* [📥 Install](appsec-portal/install/README.md)
-  * [License obtaining](appsec-portal/install/license-obtaining.md)
-  * [Installation](appsec-portal/install/installation.md)
-  * [Get started with the AppSec Portal](appsec-portal/install/get-started-with-the-appsec-portal/README.md)
-    * [Сonfiguration options](appsec-portal/install/get-started-with-the-appsec-portal/sonfiguration-options.md)
-  * [Update](appsec-portal/install/update.md)
-  * [Accessing the AppSec Portal API Endpoints](appsec-portal/install/accessing-the-appsec-portal-api-endpoints.md)
-  * [Database transfer guide](appsec-portal/install/database-transfer-guide.md)
-  * [FAQ: typical errors in deployment process](appsec-portal/install/faq-typical-errors-in-deployment-process.md)
+* [📥 Deployment](appsec-portal/deployment/README.md)
+  * [License obtaining](appsec-portal/deployment/license-obtaining.md)
+  * [Installation](appsec-portal/deployment/installation.md)
+  * [Get started with the AppSec Portal](appsec-portal/deployment/get-started-with-the-appsec-portal/README.md)
+    * [Сonfiguration options](appsec-portal/deployment/get-started-with-the-appsec-portal/sonfiguration-options.md)
+  * [Update](appsec-portal/deployment/update.md)
+  * [Accessing the AppSec Portal API Endpoints](appsec-portal/deployment/accessing-the-appsec-portal-api-endpoints.md)
+  * [Database transfer guide](appsec-portal/deployment/database-transfer-guide.md)
+  * [FAQ: typical errors in deployment process](appsec-portal/deployment/faq-typical-errors-in-deployment-process.md)
 * [🎯 Features](appsec-portal/features/README.md)
   * [Active tasks](appsec-portal/features/active-tasks.md)
   * [Custom Reports](appsec-portal/features/custom-reports.md)
@@ -154,18 +154,3 @@
   * [CWE list](appsec-portal/general-portal-settings/cwe-list.md)
   * [API](appsec-portal/general-portal-settings/api.md)
 * [🗒️ Release notes](appsec-portal/release-notes.md)
-
-## 🔎 Security Pipelines
-
-* [🔘 Features](security-pipelines/features.md)
-* [📥 Install](security-pipelines/install/README.md)
-  * [GitHub CI](security-pipelines/install/github-ci.md)
-  * [GitLab CI](security-pipelines/install/gitlab-ci.md)
-* [🏁 Actions](security-pipelines/actions/README.md)
-  * [GitHub actions](security-pipelines/actions/github-actions.md)
-  * [GitLab actions](security-pipelines/actions/gitlab-actions.md)
-
-## ✅ Requirements Generator
-
-* [🔘 Features](requirements-generator/features.md)
-* [📥 Install](requirements-generator/install.md)

appsec-portal/deployment/README.md

@@ -0,0 +1,16 @@
+---
+description: Welcome to the installation guide for AppSec Portal!
+---
+
+# 📥 Deployment
+
+## How to install
+
+There are **three steps** to installing the AppSec Portal: 
+
+* [Obtaining a license](license-obtaining.md)
+* [Installing the application](installation.md)
+* [Entering the license key in the installed application](get-started-with-the-appsec-portal/)
+
+<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th></tr></thead><tbody><tr><td><h2><a href="update.md">How to update</a></h2></td><td></td><td></td></tr><tr><td><h2><a href="../general-portal-settings/api.md">API usage</a></h2></td><td></td><td></td></tr><tr><td><h2><a href="database-transfer-guide.md">Data migration</a></h2></td><td></td><td></td></tr></tbody></table>
+

appsec-portal/install/accessing-the-appsec-portal-api-endpoints.md renamed to appsec-portal/deployment/accessing-the-appsec-portal-api-endpoints.md

@@ -0,0 +1,10 @@
+---
+description: Welcome to deployment guide for Auditor!
+---
+
+# 📥 Deployment
+
+## Choose your option
+
+<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden></th></tr></thead><tbody><tr><td><h2><a href="installation.md">How to install</a></h2></td><td></td><td></td></tr><tr><td><h2><a href="update.md">How to update</a></h2></td><td></td><td></td></tr></tbody></table>
+

appsec-portal/install/database-transfer-guide.md renamed to appsec-portal/deployment/database-transfer-guide.md

@@ -273,7 +273,7 @@ DOCKER_ENCRYPTION_TOKEN=defaultvaluetobechangedorelse...
 ACCESS_TOKEN=<your value>
 ```
 
-* <mark style="color:blue;">`IMAGE_VERSION`</mark>the <mark style="color:red;">required</mark> variable must be specified. Specify a [specific version](../../appsec-portal/release-notes.md), e.g. release\_v24.07.2
+* <mark style="color:blue;">`IMAGE_VERSION`</mark>the <mark style="color:red;">required</mark> variable must be specified. Specify a [specific version](../release-notes.md), e.g. release\_v24.07.2
 * <mark style="color:blue;">`DB_NAME`</mark>, <mark style="color:blue;">`DB_USER`</mark>, <mark style="color:blue;">`DB_PASS`</mark>, <mark style="color:blue;">`DB_HOST`</mark>, <mark style="color:blue;">`DB_PORT`</mark> variables are required for database configuration.
 * If the message broker is hosted on a third-party server, only the <mark style="color:blue;">`AMQP_HOST_STRING`</mark> must be specified. However, if the container is raised locally, all three variables, including <mark style="color:blue;">`RABBITMQ_DEFAULT_USER`</mark> and <mark style="color:blue;">`RABBITMQ_DEFAULT_PASS`</mark> need to be specified.\
   The username and password in the RABBITMQ\_DEFAULT\_PASS and RABBITMQ\_DEFAULT\_USER variables **must be the same** as in AMQP\_HOST\_STRING.