From 52d6db1cda6cc8243d0ea6660c92c899945740b8 Mon Sep 17 00:00:00 2001 From: TheTechromancer Date: Thu, 9 Nov 2023 10:59:42 -0500 Subject: [PATCH] updated readme with docker installation instructions --- README.md | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d781e6aa..51fd7c274 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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).