Skip to content

Commit

Permalink
added PostgreSQL initialization instructions to the user guide
Browse files Browse the repository at this point in the history
  • Loading branch information
caffix committed Jul 20, 2023
1 parent f61b485 commit c909cc9
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions doc/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:https://username:password@localhost:5432/ -c "CREATE DATABASE amass"
psql postgres:https://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:https://username:password@localhost:5432/amass?testing=works"
```

0 comments on commit c909cc9

Please sign in to comment.