diff --git a/content/docs/1.getting-started/03.authenticated-scan/2.scan-with-login-sequence.md b/content/docs/1.getting-started/03.authenticated-scan/2.scan-with-login-sequence.md index 24dc8ad..21138b4 100644 --- a/content/docs/1.getting-started/03.authenticated-scan/2.scan-with-login-sequence.md +++ b/content/docs/1.getting-started/03.authenticated-scan/2.scan-with-login-sequence.md @@ -69,6 +69,8 @@ Using the Chrome Extension to record a login sequence is a straightforward proce Visit [**Troubleshooting: Extension Not Opening**](/docs/getting-started/troubleshoot 'mention') if the extension doesn't open automatically in new tab along with target. +For opening and using the chrome extension in ZeroThreat On-Prem version. Refer to [**ZeroThreat Extension**](/docs/on-prem/configuration/zerothreat-extension 'mention'). + #### **3. Configure the Recorder** * Once the extension is loaded, start by clicking on the ***Stored Sequence Authentication*** button. This feature allows ZeroThreat to store and replay your authentication details, making it ideal for scheduled scans and DevOps automation. diff --git a/content/docs/1.getting-started/03.authenticated-scan/3.scan-mfa-app.md b/content/docs/1.getting-started/03.authenticated-scan/3.scan-mfa-app.md index ca785da..b941514 100644 --- a/content/docs/1.getting-started/03.authenticated-scan/3.scan-mfa-app.md +++ b/content/docs/1.getting-started/03.authenticated-scan/3.scan-mfa-app.md @@ -52,6 +52,8 @@ This guide will walk you through performing an authenticated scan on an MFA-prot Visit [**Troubleshooting: Extension Not Opening**](/docs/getting-started/troubleshoot 'mention') if the extension doesn't open automatically in new tab along with target. +For opening and using the chrome extension in ZeroThreat On-Prem version. Refer to [**ZeroThreat Extension**](/docs/on-prem/configuration/zerothreat-extension 'mention'). + #### 2. Configure the Recorder * Once the extension is loaded, Start by clicking on the **Active User Session Authentication(MFA)** button. Note that in this method ZeroThreat does not capture or store authentication details—instead, it uses a live user session (token) for authorization. You must stay logged in until the scan runs on the server. This method is perfect for applications requiring captcha, multi-factor authentication (MFA), one-time passwords (OTP), or third-party OAuth. diff --git a/content/docs/1.getting-started/03.authenticated-scan/4.scan-recorded-pages-and-actions.md b/content/docs/1.getting-started/03.authenticated-scan/4.scan-recorded-pages-and-actions.md index b6ce427..04dfecf 100644 --- a/content/docs/1.getting-started/03.authenticated-scan/4.scan-recorded-pages-and-actions.md +++ b/content/docs/1.getting-started/03.authenticated-scan/4.scan-recorded-pages-and-actions.md @@ -55,6 +55,8 @@ This will launch your target web application in a new tab, along with the **Zero Visit [**Troubleshooting: Extension Not Opening**](/docs/getting-started/troubleshoot 'mention') if the extension doesn't open automatically in new tab along with target. +For opening and using the chrome extension in ZeroThreat On-Prem version. Refer to [**ZeroThreat Extension**](/docs/on-prem/configuration/zerothreat-extension 'mention'). + #### 3. Configure the Recorder Once the extension is loaded, start by clicking on the **Stored Sequence Authentication** button. This feature allows ZeroThreat to store and replay your authentication details, making it ideal for scheduled scans and DevOps automation. diff --git a/content/docs/7.on-prem/02.installation/index.md b/content/docs/7.on-prem/02.installation/index.md index 004fc51..ca02410 100644 --- a/content/docs/7.on-prem/02.installation/index.md +++ b/content/docs/7.on-prem/02.installation/index.md @@ -15,6 +15,7 @@ Before starting the installation, ensure the following requirements are met: * **Node.js**: Latest stable version installed * **Disk space**: At least 50-100 GB of free disk space for initial installation * **Internet access**: Required during installation to download system images +* **Operating system:** Linux, macOS, or Windows using WSL > **Note**\ > Docker is not a direct prerequisite. If required, the ZeroThreat CLI installer can install and configure Docker as part of the setup process. @@ -118,16 +119,17 @@ You will be prompted to enter: * The **email address** associated with your ZeroThreat organization * A valid **On-Prem license key** -Once the On-Prem license has been purchased, you can view it in your ZeroThreat Cloud organization under the **Licenses** section. Use the organization email address and the license key shown there during installation. Atleast during installation the email used must belong to the organization where the On-Prem license was purchased. +To find these details, log in to your ZeroThreat Cloud organization and go to the **Licenses** section. The On-Prem license must already be purchased before it can be used during installation. ::fiqure-img{source="/Images/image (499).png"} :: -Once activated, the installer downloads the required images (approximately 8–9 GB). This may take several minutes depending on network speed. +During CLI installation, enter the organization email address and the license key shown in the **On-Prem Licenses** section of ZeroThreat Cloud version. The email address must belong to the same ZeroThreat organization where the On-Prem license was purchased. This allows the installer to verify that the license is being activated for the correct organization. ::fiqure-img{source="/Images/image (440).png"} :: +After the email and license key are verified, the license is activated and the installer begins downloading the required system images, approximately **12–15 GB**. This may take several minutes depending on your network speed. ### Common License Activation Error diff --git a/content/docs/7.on-prem/4.configuration/03.zerothreat-extension.md b/content/docs/7.on-prem/4.configuration/03.zerothreat-extension.md new file mode 100644 index 0000000..33490ad --- /dev/null +++ b/content/docs/7.on-prem/4.configuration/03.zerothreat-extension.md @@ -0,0 +1,70 @@ +--- +imageSrc: /Images/extension_icon.svg +title: ZeroThreat Extension +description: The ZeroThreat Chrome Extension works directly with **ZeroThreat Cloud**. However, if you are using **ZeroThreat On-Prem**, the extension needs a one-time configuration so it can connect to your On-Prem application URL. +--- + +Once configured, the extension will work normally with your On-Prem instance and can be used for authenticated scans, MFA scans, and others. + +::hint{ style="background-color:#f5fdf9; border: 1px solid #10b98133; color:#0a8363;" icon="circle-check" iconClass="text-[#0a8363]"} + +##### **When is this required?** +###### This setup is required only when you want to use the ZeroThreat Chrome Extension with a ZeroThreat **On-Prem** instance. +###### If you are using ZeroThreat **Cloud**, no additional extension configuration is required. +:: + +## Configure the Extension for On-Prem + +#### **Step 1: Open the ZeroThreat Extension** + +Click the **ZeroThreat Extension** icon from your Chrome toolbar. + +::fiqure-img{source="/Images/extension-step1.png"} + +:: + +This opens the extension popup. + +::fiqure-img{source="/Images/extension-step1-popup.png"} + +:: + +#### **Step 2: Open Extension Settings** + +Inside the extension popup, click the Setting () icon. + +This opens the On-Premise Application URL setting. + +#### **Step 3: Enter Your On-Prem Application URL** + +In the On-Premise Application URL field, enter your ZeroThreat On-Prem application URL. + +::fiqure-img{source="/Images/extension-step3.png"} + +:: + +Example: + +::u-code +```yml +https://local.zerothreat.webscan.ai +``` +:: + +Click **Save**. + +Once saved, the extension will connect to your On-Prem instance and work normally for supported extension-based workflows. + +## Switching Back to ZeroThreat Cloud + +You can keep the On-Prem application URL configured for as long as you are using the extension with ZeroThreat On-Prem. + +If you later want to use the extension with **ZeroThreat Cloud**, remove the On-Prem URL from the extension settings and click **Save** again. + +After saving the empty value, the extension will return to its default Cloud behavior. + +## Using the Extension After Configuration + +After the On-Prem application URL is saved, you can use the ZeroThreat Extension normally with your On-Prem instance. The extension will connect to your configured On-Prem URL and can be used for scanning workflows such as authenticated scans, MFA-protected application scans, and others. + +For detailed steps on using the extension during scans, refer to the [**Authenticated Scan**](/docs/getting-started/authenticated-scan 'mention'), [**Scan MFA App**](/docs/getting-started/authenticated-scan/scan-mfa-app 'mention'), and [**Scan Recorded Pages & Actions**](/docs/getting-started/authenticated-scan/scan-recorded-pages-and-actions 'mention') guides. diff --git a/public/Images/extension-step1-popup.png b/public/Images/extension-step1-popup.png new file mode 100644 index 0000000..3ea2cf2 Binary files /dev/null and b/public/Images/extension-step1-popup.png differ diff --git a/public/Images/extension-step1.png b/public/Images/extension-step1.png new file mode 100644 index 0000000..5973da4 Binary files /dev/null and b/public/Images/extension-step1.png differ diff --git a/public/Images/extension-step3.png b/public/Images/extension-step3.png new file mode 100644 index 0000000..a653134 Binary files /dev/null and b/public/Images/extension-step3.png differ diff --git a/public/Images/extension-step4.png b/public/Images/extension-step4.png new file mode 100644 index 0000000..26db82e Binary files /dev/null and b/public/Images/extension-step4.png differ diff --git a/public/Images/extension_icon.svg b/public/Images/extension_icon.svg index 95a56bb..b9fd5a3 100644 --- a/public/Images/extension_icon.svg +++ b/public/Images/extension_icon.svg @@ -1 +1 @@ - \ No newline at end of file + \ No newline at end of file diff --git a/public/Images/image (499).png b/public/Images/image (499).png index 866ed69..f2d2b1b 100644 Binary files a/public/Images/image (499).png and b/public/Images/image (499).png differ