Skip to content

Point API-key docs to secrets.yml - #3283

Merged
liquidsec merged 3 commits into
devfrom
readme-api-keys-secrets
Jul 9, 2026
Merged

Point API-key docs to secrets.yml#3283
liquidsec merged 3 commits into
devfrom
readme-api-keys-secrets

Conversation

@liquidsec

Copy link
Copy Markdown
Collaborator

Closes #3270.

A few sections of the docs still directed users to put API keys in
bbot.yml when they belong in secrets.yml (which is what
api_key: str = Field(..., sensitive=True) and the auto-generated
template both dictate).

Verified against the code:

  • Both bbot.yml and secrets.yml are auto-created on first run
    (ModuleLoader.ensure_config_files).
  • secrets.yml is loaded after bbot.yml and overrides it on
    conflict (get_custom_config -> deep_merge(bbot.yml, secrets.yml)).
  • The auto-generated secrets.yml template is built from
    secrets_only_config(), which filters to fields marked
    sensitive=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 the
    shodan_dns.api_key example; the http_proxy example is left in
    bbot.yml since it's not sensitive)

liquidsec added 2 commits July 9, 2026 10:46
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".
@liquidsec
liquidsec requested a review from en0f July 9, 2026 14:49
@codecov

codecov Bot commented Jul 9, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90%. Comparing base (0a83067) to head (d5d0efe).
⚠️ Report is 54 commits behind head on dev.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@liquidsec
liquidsec merged commit cb695bd into dev Jul 9, 2026
25 of 26 checks passed
@liquidsec
liquidsec deleted the readme-api-keys-secrets branch July 9, 2026 19:48
@liquidsec liquidsec mentioned this pull request Jul 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants