GitHub - prowler-cloud/prowler: Prowler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment.

Prowler is the Open Cloud Security platform trusted by thousands to automate security and compliance in any cloud environment. With hundreds of ready-to-use checks and compliance frameworks, Prowler delivers real-time, customizable monitoring and seamless integrations, making cloud security simple, scalable, and cost-effective for organizations of any size.

Secure ANY cloud at AI Speed at prowler.com

Join our Prowler community!

Description

Prowler is the world’s most widely used open-source cloud security platform that automates security and compliance across any cloud environment. With hundreds of ready-to-use security checks, remediation guidance, and compliance frameworks, Prowler is built to “Secure ANY cloud at AI Speed”. Prowler delivers AI-driven, customizable, and easy-to-use assessments, dashboards, reports, and integrations, making cloud security simple, scalable, and cost-effective for organizations of any size.

Prowler includes hundreds of built-in controls to ensure compliance with standards and frameworks, including:

• Prowler ThreatScore: Weighted risk prioritization scoring that helps you focus on the most critical security findings first
• Industry Standards: CIS, NIST 800, NIST CSF, CISA, and MITRE ATT&CK
• Regulatory Compliance and Governance: RBI, FedRAMP, PCI-DSS, and NIS2
• Frameworks for Sensitive Data and Privacy: GDPR, HIPAA, and FFIEC
• Frameworks for Organizational Governance and Quality Control: SOC2, GXP, and ISO 27001
• Cloud-Specific Frameworks: AWS Foundational Technical Review (FTR), AWS Well-Architected Framework, and BSI C5
• National Security Standards: ENS (Spanish National Security Scheme) and KISA ISMS-P (Korean)
• Custom Security Frameworks: Tailored to your needs

Prowler App / Prowler Cloud

Prowler App / Prowler Cloud is a web-based application that simplifies running Prowler across your cloud provider accounts. It provides a user-friendly interface to visualize the results and streamline your security assessments.

For more details, refer to the Prowler App Documentation

Prowler CLI

Prowler Dashboard

Prowler at a Glance

💻 Installation

Prowler App

Prowler App offers flexible installation methods tailored to various environments:

For detailed instructions on using Prowler App, refer to the Prowler App Usage Guide.

Docker Compose

Requirements

• Docker Compose installed: https://docs.docker.com/compose/install/.

Commands

curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/docker-compose.yml
curl -LO https://raw.githubusercontent.com/prowler-cloud/prowler/refs/heads/master/.env
docker compose up -d

Containers are built for linux/amd64.

Configuring Your Workstation for Prowler App

If your workstation's architecture is incompatible, you can resolve this by:

• Setting the environment variable: DOCKER_DEFAULT_PLATFORM=linux/amd64
• Using the following flag in your Docker command: --platform linux/amd64

Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started.

Common Issues with Docker Pull Installation

You can find more information in the Troubleshooting section.

From GitHub

Requirements

• git installed.
• poetry v2 installed: poetry installation.
• pnpm installed: pnpm installation.
• Docker Compose installed: https://docs.docker.com/compose/install/.

Commands to run the API

git clone https://github.com/prowler-cloud/prowler
cd prowler/api
poetry install
eval $(poetry env activate)
set -a
source .env
docker compose up postgres valkey -d
cd src/backend
python manage.py migrate --database admin
gunicorn -c config/guniconf.py config.wsgi:application

After completing the setup, access the API documentation at http://localhost:8080/api/v1/docs.

Commands to run the API Worker

git clone https://github.com/prowler-cloud/prowler
cd prowler/api
poetry install
eval $(poetry env activate)
set -a
source .env
cd src/backend
python -m celery -A config.celery worker -l info -E

Commands to run the API Scheduler

git clone https://github.com/prowler-cloud/prowler
cd prowler/api
poetry install
eval $(poetry env activate)
set -a
source .env
cd src/backend
python -m celery -A config.celery beat -l info --scheduler django_celery_beat.schedulers:DatabaseScheduler

Commands to run the UI

git clone https://github.com/prowler-cloud/prowler
cd prowler/ui
pnpm install
pnpm run build
pnpm start

Once configured, access the Prowler App at http://localhost:3000. Sign up using your email and password to get started.

Prowler CLI

Pip package

Prowler CLI is available as a project in PyPI. Consequently, it can be installed using pip with Python >3.9.1, <3.13:

pip install prowler
prowler -v

For further guidance, refer to https://docs.prowler.com

Containers

Available Versions of Prowler CLI

The following versions of Prowler CLI are available, depending on your requirements:

• latest: Synchronizes with the master branch. Note that this version is not stable.
• v4-latest: Synchronizes with the v4 branch. Note that this version is not stable.
• v3-latest: Synchronizes with the v3 branch. Note that this version is not stable.
• <x.y.z> (release): Stable releases corresponding to specific versions. You can find the complete list of releases here.
• stable: Always points to the latest release.
• v4-stable: Always points to the latest release for v4.
• v3-stable: Always points to the latest release for v3.

The container images are available here:

• Prowler CLI:
  • DockerHub
  • AWS Public ECR
• Prowler App:
  • DockerHub - Prowler UI
  • DockerHub - Prowler API

From GitHub

Python >3.9.1, <3.13 is required with pip and Poetry:

git clone https://github.com/prowler-cloud/prowler
cd prowler
eval $(poetry env activate)
poetry install
python prowler-cli.py -v

✏️ High level architecture

Prowler App

Prowler App is composed of four key components:

• Prowler UI: A web-based interface, built with Next.js, providing a user-friendly experience for executing Prowler scans and visualizing results.
• Prowler API: A backend service, developed with Django REST Framework, responsible for running Prowler scans and storing the generated results.
• Prowler SDK: A Python SDK designed to extend the functionality of the Prowler CLI for advanced capabilities.
• Prowler MCP Server: A Model Context Protocol server that provides AI tools for Lighthouse, the AI-powered security assistant. This is a critical dependency for Lighthouse functionality.

Prowler CLI

Running Prowler

Prowler can be executed across various environments, offering flexibility to meet your needs. It can be run from:

• Your own workstation

• A Kubernetes Job

• Google Compute Engine

• Azure Virtual Machines (VMs)

• Amazon EC2 instances

• AWS Fargate or other container platforms

• CloudShell

And many more environments.

📖 Documentation

For installation instructions, usage details, tutorials, and the Developer Guide, visit https://docs.prowler.com/

📃 License

Prowler is licensed under the Apache License 2.0.

A copy of the License is available at http://www.apache.org/licenses/LICENSE-2.0