Skip to content

Commit

Permalink
docs(install): Add brew and github installation to quick start (#1991)
Browse files Browse the repository at this point in the history
  • Loading branch information
toniblyx authored Mar 2, 2023
1 parent ffb1a2e commit b407369
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,23 @@ Prowler is available as a project in [PyPI](https://pypi.org/project/prowler-clo
prowler -v
```

=== "GitHub"

_Requirements for Developers_:

* AWS and/or Azure credentials
* `git`, `Python >= 3.9`, `pip` and `poetry` installed (`pip install poetry`)

_Commands_:

```
git clone https://github.com/prowler-cloud/prowler
cd prowler
poetry shell
poetry install
python prowler.py -v
```

=== "Amazon Linux 2"

_Requirements_:
Expand All @@ -103,6 +120,20 @@ Prowler is available as a project in [PyPI](https://pypi.org/project/prowler-clo
prowler -v
```

=== "Brew"

_Requirements_:

* `Brew` installed in your Mac or Linux
* AWS and/or Azure credentials

_Commands_:

``` bash
brew install prowler
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:
Expand Down

0 comments on commit b407369

Please sign in to comment.