From cdcb5e7aee08611eb2fc1025693316f7037fef54 Mon Sep 17 00:00:00 2001 From: AnonymousWP <50231698+AnonymousWP@users.noreply.github.com> Date: Thu, 11 May 2023 16:38:07 +0200 Subject: [PATCH 1/2] docs(readme): add note about example usage --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 56ff6b41..0ecb38e2 100644 --- a/README.md +++ b/README.md @@ -107,9 +107,9 @@ 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: @@ -401,6 +401,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 @@ -628,7 +630,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 -[](https://github.com/0xtavian) +[](https://github.com/0xtavian) ## Thanks :pray: From 37f779bd1028c0c97ef15b842f64576ac2cad7f1 Mon Sep 17 00:00:00 2001 From: AnonymousWP <50231698+AnonymousWP@users.noreply.github.com> Date: Thu, 11 May 2023 17:10:42 +0200 Subject: [PATCH 2/2] docs(readme): improve Docker documentation --- README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 0ecb38e2..0e1dc235 100644 --- a/README.md +++ b/README.md @@ -112,7 +112,11 @@ docker run -it --rm \ 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