From f8a2527429658e2d971367570b0238bdafa6dc03 Mon Sep 17 00:00:00 2001 From: Nacho Rivera <59198746+n4ch04@users.noreply.github.com> Date: Mon, 21 Nov 2022 09:38:04 +0100 Subject: [PATCH] fix(README): include more details about db connector (#1507) --- README.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 85aa782b88..8d9e13d971 100644 --- a/README.md +++ b/README.md @@ -366,7 +366,11 @@ Install psql #### Audit ID Field -Prowler can add an optional `audit_id` field to identify each audit that has been made in the database. You can do this by adding the `-u audit_id` flag to the prowler command. +To use Prowler postgres connector it is needed to set the -u flag to include `audit_id` field into the query. This field helps to identify each audit that has been made in the database. This field needs to be an UUID V4 to match the table schema. +For example: +``` +./prowler -M csv -d postgresql -u e5a0f214-8bf9-4600-a0c3-ff659b30e6c0 +``` #### Credentials @@ -427,7 +431,7 @@ prowler_start_time text ``` - Execute Prowler with `-d` flag, for example: - `./prowler -M csv -d postgresql` + `./prowler -M csv -d postgresql -u e5a0f214-8bf9-4600-a0c3-ff659b30e6c0` > _Note_: This command creates a `csv` output file and stores the Prowler output in the configured PostgreSQL DB. It's an example, `-d` flag **does not** require `-M` to run. ## Output Formats