Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): improve Docker documentation #707

Merged
merged 2 commits into from
May 11, 2023
Merged

docs(readme): improve Docker documentation #707

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cdcb5e7
docs(readme): add note about example usage
AnonymousWP May 11, 2023
37f779b
docs(readme): improve Docker documentation
AnonymousWP May 11, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 11 additions & 5 deletions README.md
View file
Open in desktop
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