ghndrx/prowler
1
0
Fork 0
mirror of https://github.com/ghndrx/prowler.git synced 2026-02-13 00:05:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat(docs): add Powler config.yaml information to docs (#1546)

Browse Source 
Co-authored-by: sergargar <sergio@verica.io>
This commit is contained in:
Sergio Garcia
2022-12-19 14:27:25 +01:00
committed by GitHub
parent 38ba009794
commit 2ddf3c8881
3 changed files with 88 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@@ -1,6 +1,6 @@
<p align="center">
<img align="center" src="https://github.com/prowler-cloud/prowler/tree/prowler-3.0-dev/docs/img/prowler-pro-dark.png#gh-dark-mode-only" width="150" height="36">
<img align="center" src="https://github.com/prowler-cloud/prowler/tree/prowler-3.0-dev/docs/img/prowler-pro-light.png#gh-light-mode-only" width="15%" height="15%">
<img align="center" src="docs/img/prowler-pro-dark.png#gh-dark-mode-only" width="150" height="36">
<img align="center" src="docs/img/prowler-pro-light.png#gh-light-mode-only" width="15%" height="15%">
</p>
<p align="center">
<b><i>&nbsp&nbsp&nbsp See all the things you and your team can do with ProwlerPro at <a href="https://prowler.pro">prowler.pro</a></i></b>
@@ -58,7 +58,7 @@ The container images are available here:
You can run Prowler from your workstation, an EC2 instance, Fargate or any other container, Codebuild, CloudShell and Cloud9.
![Architecture](https://github.com/prowler-cloud/prowler/tree/prowler-3.0-dev/docs/img/architecture.png)
![Architecture](docs/img/architecture.png)
# 📝 Requirements
@@ -98,7 +98,7 @@ To run prowler, you will need to specify the provider (e.g aws or azure):
prowler <provider>
```
![Prowler Execution](https://github.com/prowler-cloud/prowler/tree/prowler-3.0-dev/docs/img/short-display.png)
![Prowler Execution](docs/img/short-display.png)
> Running the `prowler` command without options will use your environment variable credentials.
@@ -135,6 +135,13 @@ You can always use `-h`/`--help` to access to the usage information and all the
prowler -h
```
## Checks Configurations
Several Prowler's checks have user configurable variables that can be modified in a common **configuration file**.
This file can be found in the following path:
```
prowler/config/config.yaml
```
## AWS
Use a custom AWS profile with `-p`/`--profile` and/or AWS regions which you want to audit with `-f`/`--filter-region`: