From c909cc99080499dad91e3f90718c9802d7a2fffe Mon Sep 17 00:00:00 2001 From: caffix Date: Thu, 20 Jul 2023 16:28:35 -0400 Subject: [PATCH] added PostgreSQL initialization instructions to the user guide --- doc/user_guide.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/doc/user_guide.md b/doc/user_guide.md index 05534c61a..dea5a5f10 100644 --- a/doc/user_guide.md +++ b/doc/user_guide.md @@ -305,3 +305,19 @@ All Amass enumeration findings are stored in a graph database. This database is When a new enumeration begins and a graph database already exists with previous findings for the same target(s), the subdomain names from those previous enumerations are utilized in the new enumeration. New DNS queries are performed against those subdomain names to ensure that they are still legitimate and to obtain current IP addresses. There is nothing preventing multiple users from sharing a single (remote) graph database and leveraging each others findings across enumerations. + +### Setting up PostgreSQL for OWASP Amass + +Once you have the postgres server running on your machine and access to the psql tool, execute the follow two commands to initialize your amass database: + +```bash +psql postgres://username:password@localhost:5432/ -c "CREATE DATABASE amass" +psql postgres://username:password@localhost:5432/ -c "ALTER DATABASE amass SET TIMEZONE to 'UTC'" +``` + +Now you can add the following setting into your Amass `config.yaml` file for storing and analyzing attack surface discoveries using PostgreSQL: + +```yaml +options: + database: "postgres://username:password@localhost:5432/amass?testing=works" +```