Skip to content

Commit c909cc9

Browse files
committed
added PostgreSQL initialization instructions to the user guide
1 parent f61b485 commit c909cc9

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

doc/user_guide.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -305,3 +305,19 @@ All Amass enumeration findings are stored in a graph database. This database is
305305
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.
306306

307307
There is nothing preventing multiple users from sharing a single (remote) graph database and leveraging each others findings across enumerations.
308+
309+
### Setting up PostgreSQL for OWASP Amass
310+
311+
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:
312+
313+
```bash
314+
psql postgres://username:password@localhost:5432/ -c "CREATE DATABASE amass"
315+
psql postgres://username:password@localhost:5432/ -c "ALTER DATABASE amass SET TIMEZONE to 'UTC'"
316+
```
317+
318+
Now you can add the following setting into your Amass `config.yaml` file for storing and analyzing attack surface discoveries using PostgreSQL:
319+
320+
```yaml
321+
options:
322+
database: "postgres://username:password@localhost:5432/amass?testing=works"
323+
```

0 commit comments

Comments
 (0)