Add module setup troubleshooting notes - #3228
Conversation
|
This is probably a good thing to have. However, we are currently in the process of updating the docs for 3.0 release so we will need to let those land first. |
There was a problem hiding this comment.
@dashitongzhi, @liquidsec asked you to wait for the 3.0 docs. They landed, so this needs a rebase and docs/troubleshooting.md now conflicts (DIRTY).
I ran every command in the diff against 3.0.1. Four don't do what the text says. Inline.
| which bbot | ||
|
|
||
| # reinstall module dependencies that BBOT manages | ||
| bbot --force-deps --help |
There was a problem hiding this comment.
馃敶 Blocking. --force-deps only sets deps.behavior = "force_install" (args.py:187); nothing installs until a scan runs. With --help it prints usage and exits. Line 60 already pairs --force-deps with a real scan. Drop this one.
| bbot --force-deps --help | ||
|
|
||
| # inspect the module's documented options and requirements | ||
| bbot -ml <module_name> |
There was a problem hiding this comment.
馃敶 Blocking. -ml is not a flag:
$ bbot -ml shodan_dns
bbot: error: unrecognized arguments: shodan_dns
Use -mh/--module-help (args.py:357), which prints the module's options including api_key.
|
|
||
| # inspect the module's documented options and requirements | ||
| bbot -ml <module_name> | ||
| bbot -m <module_name> --help |
There was a problem hiding this comment.
馃敶 Blocking. -m is ignored here; this prints the same global help as plain --help. Fold into -mh above.
| ```yaml | ||
| modules: | ||
| shodan_dns: | ||
| api_key: "YOUR_API_KEY_HERE" |
There was a problem hiding this comment.
馃敶 Blocking. API keys go in ~/.config/bbot/secrets.yml, not bbot.yml (docs/scanning/configuration.md:5, and line 45 there has this exact snippet). Line 51 below repeats the error. Fix both, and label the fence yaml title="~/.config/bbot/secrets.yml" to match the other docs.
Summary
-cfor a single runTesting