From 90e1d21db6583965bafce625b7660a42553a7eb8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20Mart=C3=ADn?= Date: Thu, 29 Oct 2026 11:21:15 +0100 Subject: [PATCH] docs(guides): prioritize Prowler Cloud over Local Server (#13161) --- docs/AGENTS.md | 4 +++- .../installation/prowler-app.mdx | 6 +++++- docs/getting-started/products/prowler-app.mdx | 2 +- docs/introduction.mdx | 6 ++++++ .../compliance/tutorials/compliance.mdx | 16 +++++++------- .../getting-started-alibabacloud.mdx | 5 ++++- .../providers/aws/getting-started-aws.mdx | 10 ++++++--- .../providers/azure/getting-started-azure.mdx | 6 +++++- .../cloudflare/getting-started-cloudflare.mdx | 5 ++++- .../providers/gcp/authentication.mdx | 2 +- .../providers/gcp/getting-started-gcp.mdx | 6 +++++- .../providers/github/authentication.mdx | 4 ++-- .../github/getting-started-github.mdx | 14 ++++++++----- .../getting-started-googleworkspace.mdx | 5 ++++- .../providers/iac/getting-started-iac.mdx | 7 +++++-- .../providers/image/getting-started-image.mdx | 5 ++++- .../kubernetes/getting-started-k8s.mdx | 8 +++++-- .../microsoft365/getting-started-m365.mdx | 6 +++++- .../getting-started-mongodbatlas.mdx | 2 +- .../providers/oci/getting-started-oci.mdx | 8 ++++--- .../providers/okta/getting-started-okta.mdx | 5 ++++- .../vercel/getting-started-vercel.mdx | 5 ++++- .../aws-organizations-bulk-provisioning.mdx | 2 +- .../tutorials/bulk-provider-provisioning.mdx | 2 +- docs/user-guide/tutorials/prowler-app.mdx | 21 +++++++++---------- 25 files changed, 110 insertions(+), 52 deletions(-) diff --git a/docs/AGENTS.md b/docs/AGENTS.md index 45bd3f04fa..339d465764 100644 --- a/docs/AGENTS.md +++ b/docs/AGENTS.md @@ -80,6 +80,8 @@ Prowler Features are considered proper nouns. They are to be referenced without Prowler ships two product families. Use these names exactly; the former names Prowler App (now Prowler Local Server) and Prowler Enterprise (now Prowler Private Cloud) must not appear in new writing. The only allowed former-name notes are on the Prowler Product Families page (`getting-started/products/index.mdx`) and in the site-wide banner, which document the mapping. +Web UI guides are written for Prowler Cloud. Steps that open the application link to `https://cloud.prowler.com/sign-in`, and the scope is stated once at the top of the section with the AppliesTo banner (see [AppliesTo Banner for Product Scope](#appliesto-banner-for-product-scope)). Do not offer Prowler Local Server as an inline alternative in a step list ("Go to Prowler Cloud or launch Prowler Local Server"). Mention Prowler Local Server inline only where its behavior differs, for example a feature that is not available or an environment variable that must be set. + Prowler Products: * **Prowler Cloud** @@ -573,7 +575,7 @@ The default covers Prowler Cloud, Prowler Private Cloud, and Prowler Local Serve ``` -Place it on its own line below the Version Badge when one is present, otherwise directly after the imports. +Place it on its own line below the Version Badge when one is present, otherwise directly after the imports. On a page that also covers Prowler CLI, such as the provider getting-started guides, place it under the `## Prowler Cloud` heading instead, so it scopes only the web UI section. ### Cloud Marker for Subscription Content diff --git a/docs/getting-started/installation/prowler-app.mdx b/docs/getting-started/installation/prowler-app.mdx index d802385252..20365cc244 100644 --- a/docs/getting-started/installation/prowler-app.mdx +++ b/docs/getting-started/installation/prowler-app.mdx @@ -2,11 +2,15 @@ title: "Installation" --- + +[Prowler Cloud](https://cloud.prowler.com/sign-up) runs the same application with no installation or maintenance. Follow the [Prowler Cloud guide](/user-guide/tutorials/prowler-app) to start scanning right away. + + ### Installation Prowler Local Server offers flexible installation methods tailored to various environments. -Refer to the [Prowler Cloud guide](/user-guide/tutorials/prowler-app) for detailed usage instructions. +Refer to the [Prowler Cloud guide](/user-guide/tutorials/prowler-app) for detailed usage instructions, which apply to Prowler Local Server as well. Prowler configuration is based on `.env` files. Every version of Prowler can have differences on that file, so, please, use the file that corresponds with that version or repository branch or tag. diff --git a/docs/getting-started/products/prowler-app.mdx b/docs/getting-started/products/prowler-app.mdx index 76af591ba0..5d0c376b15 100644 --- a/docs/getting-started/products/prowler-app.mdx +++ b/docs/getting-started/products/prowler-app.mdx @@ -2,7 +2,7 @@ title: 'Overview' --- -Prowler Local Server is a self-hosted web application that simplifies running Prowler. It provides: +Prowler Local Server is a self-hosted web application that simplifies running Prowler. It is the open source counterpart of [Prowler Cloud](/getting-started/products/prowler-cloud), which runs the same application as a managed service. It provides: - **User-friendly interface** for configuring and executing scans - Dashboard to **view results** and manage **security findings** diff --git a/docs/introduction.mdx b/docs/introduction.mdx index 3d93b8253a..3f38087470 100644 --- a/docs/introduction.mdx +++ b/docs/introduction.mdx @@ -4,6 +4,10 @@ ![](/images/products/overview.png) + + The fastest way to run Prowler: create an account, connect a provider, and get findings without installing anything. No billing details are required during the trial period. + + Prowler ships two product families: Prowler Products, operated or licensed by the Prowler team, and Open Source projects, free to run and extend. See [Prowler product families](/getting-started/products) for every official name, including former names. ### Prowler Products @@ -25,6 +29,8 @@ Prowler ships two product families: Prowler Products, operated or licensed by th ### Open Source +Free to run and extend. Prefer the Open Source projects to run Prowler from a terminal, in CI/CD, or on infrastructure you operate yourself. + Command line tool to run security scans across all supported providers. diff --git a/docs/user-guide/compliance/tutorials/compliance.mdx b/docs/user-guide/compliance/tutorials/compliance.mdx index aad275862d..b21acf0f10 100644 --- a/docs/user-guide/compliance/tutorials/compliance.mdx +++ b/docs/user-guide/compliance/tutorials/compliance.mdx @@ -1,7 +1,7 @@ --- title: 'Compliance' sidebarTitle: 'Overview' -description: 'Run security checks against compliance frameworks, review posture across providers, use Compliance Watchlist to pin frameworks, and download CSV or PDF reports from Prowler Cloud and Prowler Local Server, or CSV reports from Prowler CLI.' +description: 'Run security checks against compliance frameworks, review posture across providers, use Compliance Watchlist to pin frameworks, and download CSV or PDF reports from Prowler Cloud, or CSV reports from Prowler CLI.' --- import { SubscriptionBanner } from "/snippets/subscription-banner.mdx" @@ -24,15 +24,15 @@ For the unified compliance score methodology used across frameworks, see [Prowle -## Prowler Cloud and Prowler Local Server +## Prowler Cloud -The Compliance section in Prowler Cloud and Prowler Local Server centralizes compliance posture across every connected provider. It aggregates scan results, surfaces Prowler ThreatScore, and exposes detailed requirement-level evidence for each supported framework. +The Compliance section in Prowler Cloud centralizes compliance posture across every connected provider. It aggregates scan results, surfaces Prowler ThreatScore, and exposes detailed requirement-level evidence for each supported framework. ### Accessing the Compliance Section To open the compliance overview, follow these steps: -1. Sign in to Prowler Cloud at [cloud.prowler.com](https://cloud.prowler.com/sign-in) or to a Prowler Local Server instance. +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in). 2. Select **Compliance** from the left navigation. The Compliance page is organized into two tabs: @@ -42,10 +42,10 @@ The Compliance page is organized into two tabs: -Compliance overview page in Prowler Cloud and Prowler Local Server showing filters, the Prowler ThreatScore card, and the framework grid +Compliance overview page in Prowler Cloud showing filters, the Prowler ThreatScore card, and the framework grid -Compliance results require at least one completed scan. If no scan has finished yet, Prowler Cloud and Prowler Local Server display a notice prompting to launch or wait for a scan to complete. +Compliance results require at least one completed scan. If no scan has finished yet, Prowler Cloud displays a notice prompting to launch or wait for a scan to complete. ### Filtering Compliance Results @@ -196,7 +196,7 @@ Frameworks without a custom layout fall back to the generic details panel, which ### Downloading Compliance Reports -Prowler Cloud and Prowler Local Server expose two formats: +Prowler Cloud exposes two formats: * **CSV report:** Every requirement, every check, and every finding for the selected scan and filters. Available for all supported frameworks. * **PDF report:** Curated executive-style report. Currently supported for Prowler ThreatScore, ENS RD2022, NIS2, and CSA CCM. Additional PDF reports are added in subsequent Prowler releases. @@ -234,7 +234,7 @@ Use the API to integrate compliance evidence into ticketing systems, executive d ## Prowler CLI -Prowler CLI evaluates the same compliance frameworks as Prowler Cloud and Prowler Local Server, and produces detailed CSV outputs alongside the standard scan results. By default, it runs every supported framework and prints a status summary at the end of the scan: +Prowler CLI evaluates the same compliance frameworks as Prowler Cloud, and produces detailed CSV outputs alongside the standard scan results. By default, it runs every supported framework and prints a status summary at the end of the scan: diff --git a/docs/user-guide/providers/alibabacloud/getting-started-alibabacloud.mdx b/docs/user-guide/providers/alibabacloud/getting-started-alibabacloud.mdx index e887ead21e..99548f8cfc 100644 --- a/docs/user-guide/providers/alibabacloud/getting-started-alibabacloud.mdx +++ b/docs/user-guide/providers/alibabacloud/getting-started-alibabacloud.mdx @@ -3,6 +3,7 @@ title: 'Getting Started With Alibaba Cloud on Prowler' --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" Prowler supports Alibaba Cloud both from the CLI and from Prowler Cloud. This guide walks you through the requirements, how to connect the provider in the UI, and how to run scans from the command line. @@ -29,6 +30,8 @@ Before you begin, make sure you have: + + ### Step 1: Get Your Alibaba Cloud Account ID 1. Log in to the [Alibaba Cloud Console](https://home.console.alibabacloud.com/) @@ -39,7 +42,7 @@ Before you begin, make sure you have: ### Step 2: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Go to "Configuration" > "Providers" ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/aws/getting-started-aws.mdx b/docs/user-guide/providers/aws/getting-started-aws.mdx index 11516e88b3..4da913dc01 100644 --- a/docs/user-guide/providers/aws/getting-started-aws.mdx +++ b/docs/user-guide/providers/aws/getting-started-aws.mdx @@ -2,8 +2,12 @@ title: 'Getting Started With AWS on Prowler' --- +import { AppliesTo } from "/snippets/applies-to.mdx" + ## Prowler Cloud + + > Walkthrough video onboarding an AWS Account using Assumed Role. @@ -18,7 +22,7 @@ title: 'Getting Started With AWS on Prowler' ### Step 2: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Go to "Configuration" > "Providers" ![Providers Page](/images/prowler-app/cloud-providers-page.png) @@ -75,7 +79,7 @@ For detailed instructions on how to create the role, see [Authentication > Assum ![New Role Info](/images/providers/get-role-arn.png) -9. Paste the ARN into the corresponding field in Prowler Cloud or Prowler Local Server +9. Paste the ARN into the corresponding field in Prowler Cloud ![Input the Role ARN](/images/providers/paste-role-arn-prowler.png) @@ -110,7 +114,7 @@ AWS accounts can also be configured using static credentials (not recommended fo For detailed instructions on how to create the credentials, see [Authentication > Credentials](/user-guide/providers/aws/authentication#credentials). -1. Complete the form in Prowler Cloud or Prowler Local Server and click "Next" +1. Complete the form in Prowler Cloud and click "Next" ![Filled credentials page](/images/providers/prowler-cloud-credentials-next.png) diff --git a/docs/user-guide/providers/azure/getting-started-azure.mdx b/docs/user-guide/providers/azure/getting-started-azure.mdx index 034e8eacfe..8f346a543c 100644 --- a/docs/user-guide/providers/azure/getting-started-azure.mdx +++ b/docs/user-guide/providers/azure/getting-started-azure.mdx @@ -2,8 +2,12 @@ title: 'Getting Started With Azure on Prowler' --- +import { AppliesTo } from "/snippets/applies-to.mdx" + ## Prowler Cloud + + > Walkthrough video onboarding an Azure Subscription using Service Principal. @@ -34,7 +38,7 @@ For detailed instructions on how to create the Service Principal and configure p ### Step 2: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Navigate to `Configuration` > `Providers` ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/cloudflare/getting-started-cloudflare.mdx b/docs/user-guide/providers/cloudflare/getting-started-cloudflare.mdx index efdae635cc..468bfecb3e 100644 --- a/docs/user-guide/providers/cloudflare/getting-started-cloudflare.mdx +++ b/docs/user-guide/providers/cloudflare/getting-started-cloudflare.mdx @@ -3,6 +3,7 @@ title: 'Getting Started With Cloudflare on Prowler' --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" Prowler for Cloudflare scans zones for security misconfigurations, including SSL/TLS settings, DNSSEC, HSTS, WAF rules, DNS records, and more. @@ -36,6 +37,8 @@ Both links open the Cloudflare Dashboard with the seven required read-only scope + + ### Step 1: Locate the Account ID 1. Log into the [Cloudflare Dashboard](https://dash.cloudflare.com). @@ -50,7 +53,7 @@ The Account ID is a 32-character hexadecimal string (e.g., `372e67954025e0ba6aaa ### Step 2: Open Prowler Cloud -1. Go to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app). +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up). 2. Navigate to "Configuration" > "Providers". ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/gcp/authentication.mdx b/docs/user-guide/providers/gcp/authentication.mdx index ce01c1ba23..0e54aa883e 100644 --- a/docs/user-guide/providers/gcp/authentication.mdx +++ b/docs/user-guide/providers/gcp/authentication.mdx @@ -89,7 +89,7 @@ This method uses the Google Cloud CLI to authenticate and is suitable for develo ![Get the FileName](/images/providers/get-temp-file-credentials.png) -8. Extract the following values for Prowler Cloud or Prowler Local Server: +8. Extract the following values for Prowler Cloud: - `client_id` - `client_secret` diff --git a/docs/user-guide/providers/gcp/getting-started-gcp.mdx b/docs/user-guide/providers/gcp/getting-started-gcp.mdx index f40542a151..b3e67a5f85 100644 --- a/docs/user-guide/providers/gcp/getting-started-gcp.mdx +++ b/docs/user-guide/providers/gcp/getting-started-gcp.mdx @@ -2,8 +2,12 @@ title: 'Getting Started With GCP on Prowler' --- +import { AppliesTo } from "/snippets/applies-to.mdx" + ## Prowler Cloud + + ### Step 1: Get the GCP Project ID 1. Go to the [GCP Console](https://console.cloud.google.com/) @@ -13,7 +17,7 @@ title: 'Getting Started With GCP on Prowler' ### Step 2: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Go to "Configuration" > "Providers" ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/github/authentication.mdx b/docs/user-guide/providers/github/authentication.mdx index 36daf3f7c6..aa575b9813 100644 --- a/docs/user-guide/providers/github/authentication.mdx +++ b/docs/user-guide/providers/github/authentication.mdx @@ -272,7 +272,7 @@ Store the `.pem` private key securely. Anyone with this key can authenticate as ## Prowler Cloud Authentication -For step-by-step setup instructions for Prowler Cloud, see the [Getting Started Guide](/user-guide/providers/github/getting-started-github#prowler-cloud-and-prowler-local-server). +For step-by-step setup instructions for Prowler Cloud, see the [Getting Started Guide](/user-guide/providers/github/getting-started-github#prowler-cloud). ### Using Personal Access Token @@ -302,7 +302,7 @@ For step-by-step setup instructions for Prowler Cloud, see the [Getting Started 3. Enter your GitHub App ID and upload the private key (`.pem` file). -For complete step-by-step instructions, see the [Getting Started Guide](/user-guide/providers/github/getting-started-github#prowler-cloud-and-prowler-local-server). +For complete step-by-step instructions, see the [Getting Started Guide](/user-guide/providers/github/getting-started-github#prowler-cloud). --- diff --git a/docs/user-guide/providers/github/getting-started-github.mdx b/docs/user-guide/providers/github/getting-started-github.mdx index 09acdfe0c9..d319c94092 100644 --- a/docs/user-guide/providers/github/getting-started-github.mdx +++ b/docs/user-guide/providers/github/getting-started-github.mdx @@ -2,6 +2,8 @@ title: 'Getting Started with GitHub' --- +import { AppliesTo } from "/snippets/applies-to.mdx" + This guide covers setting up GitHub security scanning with Prowler. Choose a preferred interface below: @@ -16,7 +18,7 @@ Prowler can scan either: - + Web-based interface with centralized management @@ -26,7 +28,9 @@ Prowler can scan either: --- -## Prowler Cloud and Prowler Local Server +## Prowler Cloud + + @@ -34,7 +38,7 @@ Prowler can scan either: ### Prerequisites -Before adding GitHub to Prowler Cloud or Prowler Local Server, ensure you have: +Before adding GitHub to Prowler Cloud, ensure you have: 1. **GitHub Account Access** - Personal GitHub account, OR @@ -46,9 +50,9 @@ Before adding GitHub to Prowler Cloud or Prowler Local Server, ensure you have: - OAuth App Token - GitHub App Credentials (Not Recommended - limited data access) -### Step 1: Access Prowler Cloud or Prowler Local Server +### Step 1: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Go to **Configuration** → **Providers** ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/googleworkspace/getting-started-googleworkspace.mdx b/docs/user-guide/providers/googleworkspace/getting-started-googleworkspace.mdx index 01e6e89986..fbf862ffd3 100644 --- a/docs/user-guide/providers/googleworkspace/getting-started-googleworkspace.mdx +++ b/docs/user-guide/providers/googleworkspace/getting-started-googleworkspace.mdx @@ -3,6 +3,7 @@ title: 'Getting Started With Google Workspace on Prowler' --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" Prowler for Google Workspace audits the organization's Google Workspace environment for security misconfigurations, including super administrator account hygiene, domain settings, and more. @@ -28,6 +29,8 @@ Set up authentication for Google Workspace with the [Google Workspace Authentica + + ### Step 1: Locate the Customer ID 1. Log into the [Google Workspace Admin Console](https://admin.google.com). @@ -42,7 +45,7 @@ The Customer ID starts with the letter "C" followed by alphanumeric characters ( ### Step 2: Open Prowler Cloud -1. Go to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app). +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up). 2. Navigate to "Configuration" > "Providers". ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/iac/getting-started-iac.mdx b/docs/user-guide/providers/iac/getting-started-iac.mdx index 9a941c633d..53712a920c 100644 --- a/docs/user-guide/providers/iac/getting-started-iac.mdx +++ b/docs/user-guide/providers/iac/getting-started-iac.mdx @@ -2,6 +2,7 @@ title: "Getting Started with the IaC Provider" --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" Prowler's Infrastructure as Code (IaC) provider enables scanning of local or remote infrastructure code for security and compliance issues using [Trivy](https://trivy.dev/). This provider supports a wide range of IaC frameworks, allowing assessment of code before deployment. @@ -35,13 +36,15 @@ Prowler IaC provider scans the following Infrastructure as Code configurations f + + ### Supported Scanners Scanner selection is not configurable in Prowler Cloud. Default scanners, misconfig and secret, run automatically during each scan. -### Step 1: Access Prowler Cloud or Prowler Local Server +### Step 1: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Go to "Configuration" > "Providers" ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/image/getting-started-image.mdx b/docs/user-guide/providers/image/getting-started-image.mdx index 6b5d30b72e..e9b50edf7f 100644 --- a/docs/user-guide/providers/image/getting-started-image.mdx +++ b/docs/user-guide/providers/image/getting-started-image.mdx @@ -3,6 +3,7 @@ title: "Getting Started with the Image Provider" --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" Prowler's Image provider enables comprehensive container image security scanning by integrating with [Trivy](https://trivy.dev/). This provider detects vulnerabilities, exposed secrets, and misconfigurations in container images, converting Trivy findings into Prowler's standard reporting format for unified security assessment. @@ -27,13 +28,15 @@ Prowler's Image provider enables comprehensive container image security scanning + + ### Supported Scanners Prowler Cloud does not support scanner selection. The vulnerability, secret, and misconfiguration scanners run automatically during each scan. ### Step 1: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Navigate to "Configuration" > "Providers" ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/kubernetes/getting-started-k8s.mdx b/docs/user-guide/providers/kubernetes/getting-started-k8s.mdx index 9ab064ef98..12b6f91eb7 100644 --- a/docs/user-guide/providers/kubernetes/getting-started-k8s.mdx +++ b/docs/user-guide/providers/kubernetes/getting-started-k8s.mdx @@ -2,11 +2,15 @@ title: 'Getting Started with Kubernetes' --- +import { AppliesTo } from "/snippets/applies-to.mdx" + ## Prowler Cloud -### Step 1: Access Prowler Cloud or Prowler Local Server + -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app) +### Step 1: Access Prowler Cloud + +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up) 2. Go to "Configuration" > "Providers" ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/microsoft365/getting-started-m365.mdx b/docs/user-guide/providers/microsoft365/getting-started-m365.mdx index fd791cbbca..b90a18971f 100644 --- a/docs/user-guide/providers/microsoft365/getting-started-m365.mdx +++ b/docs/user-guide/providers/microsoft365/getting-started-m365.mdx @@ -2,6 +2,8 @@ title: 'Getting Started With Microsoft 365 on Prowler' --- +import { AppliesTo } from "/snippets/applies-to.mdx" + **Government Cloud Support** @@ -29,6 +31,8 @@ Set up authentication for Microsoft 365 with the [Microsoft 365 Authentication]( ## Prowler Cloud + + ### Step 1: Locate the Domain ID 1. Open the Entra ID portal, then search for "Domain" or go to Identity > Settings > Domain Names. @@ -41,7 +45,7 @@ Set up authentication for Microsoft 365 with the [Microsoft 365 Authentication]( ### Step 2: Open Prowler Cloud -1. Go to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app). +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up). 2. Navigate to "Configuration" > "Providers". ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/mongodbatlas/getting-started-mongodbatlas.mdx b/docs/user-guide/providers/mongodbatlas/getting-started-mongodbatlas.mdx index bf2c76447e..766f4cfa9e 100644 --- a/docs/user-guide/providers/mongodbatlas/getting-started-mongodbatlas.mdx +++ b/docs/user-guide/providers/mongodbatlas/getting-started-mongodbatlas.mdx @@ -15,7 +15,7 @@ Before you begin, make sure you have: 3. An **API Key pair** (public and private keys) with appropriate permissions: - **Organization Read Only**: Provides read-only access to everything in the organization, including all projects in the organization. This permission is sufficient for most security checks. - **Organization Owner**: Required to audit the [Auditing configuration](https://www.mongodb.com/docs/api/doc/atlas-admin-api-v2/group/endpoint-auditing) for projects. Database auditing tracks database operations and security events, including authentication attempts, data definition language (DDL) changes, user and role modifications, and privilege grants. This configuration is essential for security monitoring, forensics, and compliance. Without **Organization Owner** permission, the `projects_auditing_enabled` check cannot retrieve the audit configuration status. -4. Access to Prowler Cloud or Prowler Local Server, or Prowler CLI (`pip install prowler`). +4. A [Prowler Cloud](https://cloud.prowler.com/sign-up) account, or Prowler CLI (`pip install prowler`). For detailed instructions on creating API keys, see the [MongoDB Atlas authentication guide](./authentication.mdx). diff --git a/docs/user-guide/providers/oci/getting-started-oci.mdx b/docs/user-guide/providers/oci/getting-started-oci.mdx index 950661ff28..0cd37a5b30 100644 --- a/docs/user-guide/providers/oci/getting-started-oci.mdx +++ b/docs/user-guide/providers/oci/getting-started-oci.mdx @@ -2,11 +2,13 @@ title: 'Getting Started with Oracle Cloud Infrastructure (OCI)' --- +import { AppliesTo } from "/snippets/applies-to.mdx" + Prowler supports security scanning of Oracle Cloud Infrastructure (OCI) environments. This guide will help you get started with using Prowler to audit your OCI tenancy. ## Prowler Cloud -The following steps apply to Prowler Cloud and Prowler Local Server. + ### Step 1: Collect OCI Identifiers 1. Sign in to the [OCI Console](https://cloud.oracle.com/) and open **Tenancy Details** to copy the Tenancy OCID. @@ -15,7 +17,7 @@ The following steps apply to Prowler Cloud and Prowler Local Server. 4. In **Tenancy Details**, note the **Home Region** identifier (for example, `me-abudhabi-1`). Any other region the tenancy is subscribed to also works. ### Step 2: Access Prowler Cloud -1. Navigate to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app). +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up). 2. Go to **Configuration** → **Providers** and click **Add Provider**. ![Add OCI Provider](./images/oci-add-cloud-provider.png) 3. Select **Oracle Cloud** and enter the **Tenancy OCID** and an optional alias, then choose **Next**. @@ -342,7 +344,7 @@ prowler oci \ **Error: "OCI credential validation failed" with `401 NotAuthenticated` on `get_tenancy`** - The tenancy is not subscribed to the region used for validation (by default `us-ashburn-1`) -- In Prowler Cloud or Prowler Local Server, update the provider credentials and select the tenancy home region +- In Prowler Cloud, update the provider credentials and select the tenancy home region - In Prowler CLI, set `region` in `~/.oci/config` to the home region. All subscribed regions are still scanned; `--region` also works but limits the scan to that region **Error: "Invalid region"** diff --git a/docs/user-guide/providers/okta/getting-started-okta.mdx b/docs/user-guide/providers/okta/getting-started-okta.mdx index dbe63807d7..dab8ab83be 100644 --- a/docs/user-guide/providers/okta/getting-started-okta.mdx +++ b/docs/user-guide/providers/okta/getting-started-okta.mdx @@ -3,6 +3,7 @@ title: 'Getting Started With Okta on Prowler' --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" Prowler for Okta scans an Okta organization for identity and session-management misconfigurations. The provider authenticates as a service application using **OAuth 2.0 with a private-key JWT** (Client Credentials grant) — no end-user login, read-only by scope. @@ -28,9 +29,11 @@ Set up authentication for Okta with the [Okta Authentication](/user-guide/provid + + ### Step 1: Add the Provider -1. Go to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app). +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up). 2. Navigate to "Configuration" > "Providers". ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/providers/vercel/getting-started-vercel.mdx b/docs/user-guide/providers/vercel/getting-started-vercel.mdx index da02019b6f..aa27b03b46 100644 --- a/docs/user-guide/providers/vercel/getting-started-vercel.mdx +++ b/docs/user-guide/providers/vercel/getting-started-vercel.mdx @@ -3,6 +3,7 @@ title: "Getting Started With Vercel on Prowler" --- import { VersionBadge } from "/snippets/version-badge.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" Prowler for Vercel scans teams and projects for security misconfigurations, including deployment protection, environment variable exposure, WAF rules, domain configuration, team access controls, and more. @@ -26,9 +27,11 @@ Set up authentication for Vercel with the [Vercel Authentication](/user-guide/pr + + ### Step 1: Add the Provider -1. Go to [Prowler Cloud](https://cloud.prowler.com/) or launch [Prowler Local Server](/user-guide/tutorials/prowler-app). +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) or [create an account](https://cloud.prowler.com/sign-up). 2. Navigate to "Configuration" > "Providers". ![Providers Page](/images/prowler-app/cloud-providers-page.png) diff --git a/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx b/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx index 9217c28b0a..2c4e82f073 100644 --- a/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx +++ b/docs/user-guide/tutorials/aws-organizations-bulk-provisioning.mdx @@ -99,7 +99,7 @@ export PROWLER_API_KEY="pk_example-api-key" To create an API key: -1. Log in to Prowler Cloud or Prowler Local Server +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) 2. Click **Profile** → **Account** 3. Click **Create API Key** 4. Provide a descriptive name and optionally set an expiration date diff --git a/docs/user-guide/tutorials/bulk-provider-provisioning.mdx b/docs/user-guide/tutorials/bulk-provider-provisioning.mdx index cc759b6f85..36a1d003d7 100644 --- a/docs/user-guide/tutorials/bulk-provider-provisioning.mdx +++ b/docs/user-guide/tutorials/bulk-provider-provisioning.mdx @@ -51,7 +51,7 @@ export PROWLER_API_KEY="pk_example-api-key" To create an API key: -1. Log in to Prowler Cloud or Prowler Local Server +1. Sign in to [Prowler Cloud](https://cloud.prowler.com/sign-in) 2. Click **Profile** → **Account** 3. Click **Create API Key** 4. Provide a descriptive name and optionally set an expiration date diff --git a/docs/user-guide/tutorials/prowler-app.mdx b/docs/user-guide/tutorials/prowler-app.mdx index a7e1670598..1b91cbe73e 100644 --- a/docs/user-guide/tutorials/prowler-app.mdx +++ b/docs/user-guide/tutorials/prowler-app.mdx @@ -4,22 +4,15 @@ sidebarTitle: 'Getting Started' --- import { ProviderCards } from "/snippets/provider-cards.mdx" +import { AppliesTo } from "/snippets/applies-to.mdx" + + **Prowler Cloud** is a web application that simplifies running Prowler. This tutorial will guide you through setting up and using it. -**Prowler Local Server** is the self-hosted version of **Prowler Cloud**. See [Prowler product families](/getting-started/products) for every official product name. - ## Accessing Prowler Cloud and API Documentation -If you are a [Prowler Cloud](https://cloud.prowler.com/sign-in) user, you can access API docs at [https://api.prowler.com/api/v1/docs](https://api.prowler.com/api/v1/docs) - - -**For Prowler Local Server users** - -After [installing](/getting-started/installation/prowler-app) **Prowler Local Server**, access it at [http://localhost:3000](http://localhost:3000). - -To view the auto-generated **Prowler API** documentation, navigate to [http://localhost:8080/api/v1/docs](http://localhost:8080/api/v1/docs). This documentation provides details on available endpoints, parameters, and responses. - +Sign in at [cloud.prowler.com](https://cloud.prowler.com/sign-in). The API documentation is available at [https://api.prowler.com/api/v1/docs](https://api.prowler.com/api/v1/docs). ## Step 1: Sign Up ### Sign Up with Email @@ -171,3 +164,9 @@ Once your scan has finished, you don’t need to grab the entire ZIP—just pull To fetch a single compliance report via API, see the Retrieve compliance report as CSV endpoint in the Prowler API Reference. [Prowler API Reference - Retrieve compliance report as CSV](https://api.prowler.com/api/v1/docs#tag/Scan/operation/scans_compliance_retrieve) + +## Running the Same Steps on Prowler Local Server + +**Prowler Local Server** is the self-hosted version of **Prowler Cloud**, and every step in this guide works the same way on it. See [Prowler product families](/getting-started/products) for every official product name. + +After [installing](/getting-started/installation/prowler-app) **Prowler Local Server**, access it at [http://localhost:3000](http://localhost:3000) and the auto-generated **Prowler API** documentation at [http://localhost:8080/api/v1/docs](http://localhost:8080/api/v1/docs).