mirror of
https://github.com/ghndrx/prowler.git
synced 2026-02-10 14:55:00 +00:00
docs(install): Add multiple ways to install Prowler (#1627)
This commit is contained in:
committed by
GitHub
parent
94bda8c17d
commit
d75b48877d
|
Before Width: | Height: | Size: 141 KiB After Width: | Height: | Size: 141 KiB |
121
docs/index.md
121
docs/index.md
@@ -31,13 +31,117 @@ Visit <a href="https://prowler.pro">prowler.pro</a> for more info.
|
|||||||
## Quick Start
|
## Quick Start
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
Prowler is available as a project in [PyPI](https://pypi.org/project/prowler-cloud/), thus can be installed using pip with Python >= 3.9:
|
Prowler is available as a project in [PyPI](https://pypi.org/project/prowler-cloud/), thus can be installed using pip with `Python >= 3.9`:
|
||||||
```bash
|
|
||||||
pip install prowler-cloud
|
|
||||||
prowler -v
|
|
||||||
```
|
|
||||||
|
|
||||||
If you want to execute Prowler from AWS CloudShell see [here](tutorials/aws/cloudshell.md).
|
|
||||||
|
=== "Generic"
|
||||||
|
|
||||||
|
_Requirements_:
|
||||||
|
|
||||||
|
* `Python >= 3.9`
|
||||||
|
* `Python pip >= 3.9`
|
||||||
|
* AWS and/or Azure credentials
|
||||||
|
|
||||||
|
_Commands_:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
pip install prowler-cloud
|
||||||
|
prowler -v
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Docker"
|
||||||
|
|
||||||
|
_Requirements_:
|
||||||
|
|
||||||
|
* Have `docker` installed: https://docs.docker.com/get-docker/.
|
||||||
|
* AWS and/or Azure credentials
|
||||||
|
* In the command below, change `-v` to your local directory path in order to access the reports.
|
||||||
|
|
||||||
|
_Commands_:
|
||||||
|
|
||||||
|
``` bash
|
||||||
|
docker run -ti --rm -v /your/local/dir/prowler-output:/home/prowler/output \
|
||||||
|
--name prowler \
|
||||||
|
--env AWS_ACCESS_KEY_ID \
|
||||||
|
--env AWS_SECRET_ACCESS_KEY \
|
||||||
|
--env AWS_SESSION_TOKEN toniblyx/prowler:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Ubuntu"
|
||||||
|
|
||||||
|
_Requirements for Ubuntu 20.04.3 LTS_:
|
||||||
|
|
||||||
|
* AWS and/or Azure credentials
|
||||||
|
* Install python 3.9 with: `sudo apt-get install python3.9`
|
||||||
|
* Remove python 3.8 to avoid conflicts if you can: `sudo apt-get remove python3.8`
|
||||||
|
* Make sure you have the python3 distutils package installed: `sudo apt-get install python3-distutils`
|
||||||
|
* To make sure you use pip for 3.9 get the get-pip script with: `curl https://bootstrap.pypa.io/get-pip.py -o get-pip.py`
|
||||||
|
* Execute it with the proper python version: `sudo python3.9 get-pip.py`
|
||||||
|
* Now you should have pip for 3.9 ready: `pip3.9 --version`
|
||||||
|
|
||||||
|
_Commands_:
|
||||||
|
|
||||||
|
```
|
||||||
|
pip3.9 install prowler-cloud
|
||||||
|
export PATH=$PATH:/home/$HOME/.local/bin/
|
||||||
|
prowler -v
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "Amazon Linux 2"
|
||||||
|
|
||||||
|
_Requirements_:
|
||||||
|
|
||||||
|
* AWS and/or Azure credentials
|
||||||
|
* Latest Amazon Linux 2 should come with Python 3.9 already installed however it may need pip. Install Python pip 3.9 with: `sudo dnf install -y python3-pip`.
|
||||||
|
* Make sure setuptools for python is already installed with: `pip3 install setuptools`
|
||||||
|
|
||||||
|
_Commands_:
|
||||||
|
|
||||||
|
```
|
||||||
|
pip3.9 install prowler-cloud
|
||||||
|
export PATH=$PATH:/home/$HOME/.local/bin/
|
||||||
|
prowler -v
|
||||||
|
```
|
||||||
|
|
||||||
|
=== "AWS CloudShell"
|
||||||
|
|
||||||
|
Prowler can be easely executed in AWS CloudShell but it has some prerequsites to be able to to so. AWS CloudShell is a container running with `Amazon Linux release 2 (Karoo)` that comes with Python 3.7, since Prowler requires Python >= 3.9 we need to first install a newer version of Python. Follow the steps below to successfully execute Prowler v3 in AWS CloudShell:
|
||||||
|
|
||||||
|
_Requirements_:
|
||||||
|
|
||||||
|
* First install all dependences and then Python, in this case we need to compile it because there is not a package available at the time this document is written:
|
||||||
|
```
|
||||||
|
sudo yum -y install gcc openssl-devel bzip2-devel libffi-devel
|
||||||
|
wget https://www.python.org/ftp/python/3.9.16/Python-3.9.16.tgz
|
||||||
|
tar zxf Python-3.9.16.tgz
|
||||||
|
cd Python-3.9.16/
|
||||||
|
./configure --enable-optimizations
|
||||||
|
sudo make altinstall
|
||||||
|
python3.9 --version
|
||||||
|
cd
|
||||||
|
```
|
||||||
|
_Commands_:
|
||||||
|
|
||||||
|
* Once Python 3.9 is available we can install Prowler from pip:
|
||||||
|
```
|
||||||
|
pip3.9 install prowler-cloud
|
||||||
|
prowler -v
|
||||||
|
```
|
||||||
|
|
||||||
|
> To download the results from AWS CloudShell, select Actions -> Download File and add the full path of each file. For the CSV file it will be something like `/home/cloudshell-user/output/prowler-output-123456789012-20221220191331.csv`
|
||||||
|
|
||||||
|
=== "Azure CloudShell"
|
||||||
|
|
||||||
|
_Requirements_:
|
||||||
|
|
||||||
|
* Open Azure CloudShell `bash`.
|
||||||
|
|
||||||
|
_Commands_:
|
||||||
|
|
||||||
|
```
|
||||||
|
pip install prowler-cloud
|
||||||
|
prowler -v
|
||||||
|
```
|
||||||
|
|
||||||
## Prowler container versions
|
## Prowler container versions
|
||||||
|
|
||||||
@@ -52,11 +156,6 @@ The container images are available here:
|
|||||||
- [DockerHub](https://hub.docker.com/r/toniblyx/prowler/tags)
|
- [DockerHub](https://hub.docker.com/r/toniblyx/prowler/tags)
|
||||||
- [AWS Public ECR](https://gallery.ecr.aws/o4g1s5r6/prowler)
|
- [AWS Public ECR](https://gallery.ecr.aws/o4g1s5r6/prowler)
|
||||||
|
|
||||||
To run it using Docker:
|
|
||||||
```
|
|
||||||
docker run -ti --rm --name prowler --env AWS_ACCESS_KEY_ID --env AWS_SECRET_ACCESS_KEY --env AWS_SESSION_TOKEN toniblyx/prowler:latest
|
|
||||||
```
|
|
||||||
|
|
||||||
## High level architecture
|
## High level architecture
|
||||||
|
|
||||||
You can run Prowler from your workstation, an EC2 instance, Fargate or any other container, Codebuild, CloudShell, Cloud9 and many more.
|
You can run Prowler from your workstation, an EC2 instance, Fargate or any other container, Codebuild, CloudShell, Cloud9 and many more.
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ prowler <provider> --compliance <compliance_framework>
|
|||||||
```
|
```
|
||||||
Standard results will be shown and additionally the framework information as the sample below for CIS AWS 1.5. For details a CSV file has been generated as well.
|
Standard results will be shown and additionally the framework information as the sample below for CIS AWS 1.5. For details a CSV file has been generated as well.
|
||||||
|
|
||||||
<img src="/img/compliance-cis-sample.png"/>
|
<img src="/img/compliance-cis-sample1.png"/>
|
||||||
|
|
||||||
## Create and contribute adding other Security Frameworks
|
## Create and contribute adding other Security Frameworks
|
||||||
|
|
||||||
|
|||||||
41
mkdocs.yml
41
mkdocs.yml
@@ -19,7 +19,7 @@ theme:
|
|||||||
primary: black
|
primary: black
|
||||||
accent: green
|
accent: green
|
||||||
|
|
||||||
edit_uri: ""
|
edit_uri: "https://github.com/prowler-cloud/prowler/tree/master/docs"
|
||||||
# Prowler OSS Repository
|
# Prowler OSS Repository
|
||||||
repo_url: https://github.com/prowler-cloud/prowler/
|
repo_url: https://github.com/prowler-cloud/prowler/
|
||||||
repo_name: prowler-cloud/prowler
|
repo_name: prowler-cloud/prowler
|
||||||
@@ -74,3 +74,42 @@ extra:
|
|||||||
|
|
||||||
# Copyright
|
# Copyright
|
||||||
copyright: Copyright © 2022 Toni de la Fuente, Maintained by the Prowler Team at Verica, Inc.</a>.
|
copyright: Copyright © 2022 Toni de la Fuente, Maintained by the Prowler Team at Verica, Inc.</a>.
|
||||||
|
|
||||||
|
markdown_extensions:
|
||||||
|
- abbr
|
||||||
|
- admonition
|
||||||
|
- attr_list
|
||||||
|
- def_list
|
||||||
|
- footnotes
|
||||||
|
- md_in_html
|
||||||
|
- toc:
|
||||||
|
permalink: true
|
||||||
|
- pymdownx.arithmatex:
|
||||||
|
generic: true
|
||||||
|
- pymdownx.betterem:
|
||||||
|
smart_enable: all
|
||||||
|
- pymdownx.caret
|
||||||
|
- pymdownx.details
|
||||||
|
- pymdownx.emoji:
|
||||||
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
||||||
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
||||||
|
- pymdownx.highlight:
|
||||||
|
anchor_linenums: true
|
||||||
|
- pymdownx.inlinehilite
|
||||||
|
- pymdownx.keys
|
||||||
|
- pymdownx.magiclink:
|
||||||
|
repo_url_shorthand: true
|
||||||
|
user: squidfunk
|
||||||
|
repo: mkdocs-material
|
||||||
|
- pymdownx.mark
|
||||||
|
- pymdownx.smartsymbols
|
||||||
|
- pymdownx.superfences:
|
||||||
|
custom_fences:
|
||||||
|
- name: mermaid
|
||||||
|
class: mermaid
|
||||||
|
format: !!python/name:pymdownx.superfences.fence_code_format
|
||||||
|
- pymdownx.tabbed:
|
||||||
|
alternate_style: true
|
||||||
|
- pymdownx.tasklist:
|
||||||
|
custom_checkbox: true
|
||||||
|
- pymdownx.tilde
|
||||||
Reference in New Issue
Block a user