From 86cf480f90edc100521eee2b42a782bb9e3f9eb9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rub=C3=A9n=20De=20la=20Torre=20Vico?= Date: Fri, 27 Sep 2024 10:50:01 +0200 Subject: [PATCH] docs: add Ubuntu installation --- docs/index.md | 36 +++++++++++++++++++++++++++--------- 1 file changed, 27 insertions(+), 9 deletions(-) diff --git a/docs/index.md b/docs/index.md index 4ca7920d1b..3cafcde984 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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 ``` @@ -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_: