Skip to content

chore(agent): Use placeholder values in example config#146

Merged
nfebe merged 1 commit into
mainfrom
chore/example-config-placeholders
Jun 8, 2026
Merged

chore(agent): Use placeholder values in example config#146
nfebe merged 1 commit into
mainfrom
chore/example-config-placeholders

Conversation

@nfebe

@nfebe nfebe commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

Example configuration should ship with inert placeholder values that each operator replaces with their own settings. This updates the remaining concrete values to clearly labelled placeholders.

Example configuration should ship with inert placeholder values that
each operator replaces with their own settings. This updates the
remaining concrete values to clearly labelled placeholders.
@sourceant

sourceant Bot commented Jun 8, 2026

Copy link
Copy Markdown

Code Review Summary

This PR replaces hardcoded API keys and tokens in the example configuration file with descriptive placeholder values. This is a best practice for open-source repositories to prevent credential leakage and guide users.

🚀 Key Improvements

  • Removal of a concrete Google Gemini API key from config.example.yml.
  • Replacement of a static internal API token with a prompt for the user to generate a secure string.
  • Standardization of placeholder naming across different service sections (PowerDNS, AI, Internal API).

💡 Minor Suggestions

  • Adding quotes around placeholder strings in YAML is generally safer to avoid any potential parsing issues with special characters, though not strictly required for these specific strings.

@sourceant sourceant Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review complete. See the overview comment for a summary.

Comment thread config.example.yml
unique_paths_threshold: 20
repeated_hits_threshold: 30
internal_api_token: ff66c51caad086544e7a6372b681da856146ae5586b6b59408d613fbc85f0045
internal_api_token: generate-a-secure-random-string-here

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While replacing the token with a placeholder is correct, for an 'internal_api_token', it is helpful to suggest a specific command or length to ensure users generate a token with sufficient entropy.

Suggested change
internal_api_token: generate-a-secure-random-string-here
+ internal_api_token: "<generate-32-char-random-string>"

@nfebe nfebe merged commit 54cfa43 into main Jun 8, 2026
2 checks passed
@nfebe nfebe deleted the chore/example-config-placeholders branch June 8, 2026 11:27
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.

1 participant