Skip to content

Commit

Permalink
Merge pull request #835 from blacklanternsecurity/update-readme
Browse files Browse the repository at this point in the history
Updated readme with docker installation instructions
  • Loading branch information
TheTechromancer authored Nov 9, 2023
2 parents 8515b11 + 52d6db1 commit e51742e
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ BBOT typically outperforms other subdomain enumeration tools by 20-25%. To learn

## Installation ([pip](https://pypi.org/project/bbot/))

Note: Requires Linux and Python 3.9+. For more installation methods including [Docker](https://hub.docker.com/r/blacklanternsecurity/bbot), see [Installation](https://www.blacklanternsecurity.com/bbot/#installation).
Note: Requires Linux and Python 3.9+.

```bash
# stable version
Expand All @@ -30,6 +30,23 @@ pipx install --pip-args '\--pre' bbot
bbot --help
```

## Installation ([Docker](https://hub.docker.com/r/blacklanternsecurity/bbot))

Docker images are provided, along with helper script `bbot-docker.sh` to persist your scan data.

```bash
# bleeding edge (dev)
docker run -it blacklanternsecurity/bbot --help

# stable
docker run -it blacklanternsecurity/bbot:stable --help

# helper script
git clone https://github.com/blacklanternsecurity/bbot && cd bbot
./bbot-docker.sh --help
```


## Example Commands

Scan output, logs, etc. are saved to `~/.bbot`. For more detailed examples and explanations, see [Scanning](https://www.blacklanternsecurity.com/bbot/scanning).
Expand Down

0 comments on commit e51742e

Please sign in to comment.