chore(agent): Use placeholder values in example config#146
Merged
Conversation
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.
Code Review SummaryThis 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
💡 Minor Suggestions
|
| unique_paths_threshold: 20 | ||
| repeated_hits_threshold: 30 | ||
| internal_api_token: ff66c51caad086544e7a6372b681da856146ae5586b6b59408d613fbc85f0045 | ||
| internal_api_token: generate-a-secure-random-string-here |
There was a problem hiding this comment.
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>" |
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.
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.