From 4d08937221b23661e84f55356b2c5b56eb357d48 Mon Sep 17 00:00:00 2001
From: github-actions <github-actions@github.com>
Date: Thu, 5 Dec 2024 11:12:34 -0500
Subject: [PATCH] better docker documentation

---
 docs/index.md | 12 ++++++++++++
 1 file changed, 12 insertions(+)

diff --git a/docs/index.md b/docs/index.md
index 3d6c5ef267..355d58e8b2 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -34,6 +34,8 @@ bbot --help
 
 Docker images are provided, along with helper script `bbot-docker.sh` to persist your scan data.
 
+Scans are output to `~/.bbot/scans` (the usual place for BBOT scan data).
+
 ```bash
 # bleeding edge (dev)
 docker run -it blacklanternsecurity/bbot --help
@@ -46,6 +48,16 @@ git clone https://github.com/blacklanternsecurity/bbot && cd bbot
 ./bbot-docker.sh --help
 ```
 
+Note: If you need to pass in a custom preset, you can do so by mapping the preset into the container:
+
+```bash
+# use the preset `my_preset.yml` from the current directory
+docker run --rm -it \
+  -v "$HOME/.bbot/scans:/root/.bbot/scans" \
+  -v "$PWD/my_preset.yml:/my_preset.yml" \
+  blacklanternsecurity/bbot -p /my_preset.yml
+```
+
 ## Example Commands
 
 Below are some examples of common scans.