Skip to content

Commit

Permalink
Merge pull request #707 from AnonymousWP/improve-readme
Browse files Browse the repository at this point in the history
docs(readme): improve Docker documentation
  • Loading branch information
six2dez authored May 11, 2023
2 parents ecb0535 + 37f779b commit 102d4e7
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,16 @@ docker pull six2dez/reconftw:main
- Run the container

```bash
$ docker run -it --rm \
-v "${PWD}/OutputFolder/":'/reconftw/Recon/' \
six2dez/reconftw:main -d example.com -r
docker run -it --rm \
-v "${PWD}/OutputFolder/":'/reconftw/Recon/' \
six2dez/reconftw:main -d example.com -r
```

However, if you wish to:
- View results (they're NOT in the Docker container)

- As the folder you cloned earlier (named `reconftw`) is being renamed to `OutputFolder`, you'll have to go to that folder to view results.

If you wish to:

1. Dynamically modify the behaviour & function of the image
2. Build your own container
Expand Down Expand Up @@ -401,6 +405,8 @@ reset='\033[0m'

## Example Usage

**NOTE: this is applicable when you've installed reconFTW on the host (e.g. VM/VPS/cloud) and not in a Docker container.**

### To perform a full recon on single target

```bash
Expand Down Expand Up @@ -628,7 +634,7 @@ If you want to contribute to this project, you can do it in multiple ways:

This section shows the current financial sponsors of this project

[<img src="https://pbs.twimg.com/profile_images/1360304248534282240/MomOFi40_400x400.jpg" width="100" height=auto>](https://github.com/0xtavian)
[<img src="https://pbs.twimg.com/profile_images/1578131929794314272/b79Rezd4_400x400.png" width="100" height=auto>](https://github.com/0xtavian)

## Thanks :pray:

Expand Down

0 comments on commit 102d4e7

Please sign in to comment.