Skip to content

Commit

Permalink
docs: add Ubuntu installation
Browse files Browse the repository at this point in the history
  • Loading branch information
puchy22 committed Sep 27, 2024
1 parent d5b297f commit 86cf480
Showing 1 changed file with 27 additions and 9 deletions.
36 changes: 27 additions & 9 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,38 +21,38 @@ It contains hundreds of controls covering CIS, NIST 800, NIST CSF, CISA, RBI, Fe

Prowler is available as a project in [PyPI](https://pypi.org/project/prowler/), thus can be installed as Python package with `Python >= 3.9`:

=== "pip"
=== "pipx"

???+ warning
This method is not recommended because it will modify the environment which you choose to install. Consider using `pipx` for a global installation.
[pipx](https://pipx.pypa.io/stable/) is a tool to install Python applications in isolated environments. It is recommended to use `pipx` for a global installation.

_Requirements_:

* `Python >= 3.9`
* `Python pip >= 21.0.0`
* `pipx` installed: [pipx installation](https://pipx.pypa.io/stable/installation/).
* AWS, GCP, Azure and/or Kubernetes credentials

_Commands_:

``` bash
pip install prowler
pipx install prowler
prowler -v
```

=== "pipx"
=== "pip"

[pipx](https://pipx.pypa.io/stable/) is a tool to install Python applications in isolated environments. It is recommended to use `pipx` for a global installation.
???+ warning
This method is not recommended because it will modify the environment which you choose to install. Consider using [pipx](https://docs.prowler.com/projects/prowler-open-source/en/latest/#__tabbed_1_1) for a global installation.

_Requirements_:

* `Python >= 3.9`
* `pipx` installed: [pipx installation](https://pipx.pypa.io/stable/installation/).
* `Python pip >= 21.0.0`
* AWS, GCP, Azure and/or Kubernetes credentials

_Commands_:

``` bash
pipx install prowler
pip install prowler
prowler -v
```

Expand Down Expand Up @@ -109,6 +109,24 @@ Prowler is available as a project in [PyPI](https://pypi.org/project/prowler/),
prowler -v
```

=== "Ubuntu"

_Requirements_:

* `Ubuntu 23.04` or above, if you are using an older version of Ubuntu check [pipx installation](https://docs.prowler.com/projects/prowler-open-source/en/latest/#__tabbed_1_1) and ensure you have `Python >= 3.9`.
* `Python >= 3.9`
* AWS, GCP, Azure and/or Kubernetes credentials

_Commands_:

``` bash
sudo apt update
sudo apt install pipx
pipx ensurepath
pipx install prowler
prowler -v
```

=== "Brew"

_Requirements_:
Expand Down

0 comments on commit 86cf480

Please sign in to comment.