Point API-key docs to secrets.yml - #3283
Merged
Merged
Conversation
Update README, docs/index.md, and docs/scanning/configuration.md to direct API-key config to ~/.config/bbot/secrets.yml, and note that both bbot.yml and secrets.yml are loaded and auto-created. Closes #3270.
Three code fences read "~/.bbot/config/bbot.yml"; the actual path is "~/.config/bbot/bbot.yml".
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## dev #3283 +/- ##
=====================================
- Coverage 90% 90% -0%
=====================================
Files 450 450
Lines 46155 46155
=====================================
- Hits 41409 41408 -1
- Misses 4746 4747 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
en0f
approved these changes
Jul 9, 2026
en0f
approved these changes
Jul 9, 2026
en0f
approved these changes
Jul 9, 2026
en0f
approved these changes
Jul 9, 2026
en0f
approved these changes
Jul 9, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #3270.
A few sections of the docs still directed users to put API keys in
bbot.ymlwhen they belong insecrets.yml(which is whatapi_key: str = Field(..., sensitive=True)and the auto-generatedtemplate both dictate).
Verified against the code:
bbot.ymlandsecrets.ymlare auto-created on first run(
ModuleLoader.ensure_config_files).secrets.ymlis loaded afterbbot.ymland overrides it onconflict (
get_custom_config->deep_merge(bbot.yml, secrets.yml)).secrets.ymltemplate is built fromsecrets_only_config(), which filters to fields markedsensitive=True(i.e.api_key, etc.).Files updated:
README.md(the line called out in the issue)docs/index.md(API keys section)docs/scanning/configuration.md(intro, file list, and theshodan_dns.api_keyexample; thehttp_proxyexample is left inbbot.ymlsince it's not sensitive)