docs(self-hosted): add required ai keys to evaluator values overlay#14
Merged
Conversation
Step 9 of the local-evaluation guide was missing the global.required.ai block. Without openAiKeyFree / openAiKeySwe set, scans hang at "Scanning in progress" — the same failure mode already documented in the "Scan stays at Scanning in progress forever" troubleshooting entry. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Updates every chart version mention (intro note, prereq section, secrets comment, values overlay, install command, troubleshooting entries) from 1.2.3 to 1.2.4. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the self-hosted Evaluator installation guide to include missing global.required.ai configuration in the step 9 values overlay so AI enrichment can start correctly during scans.
Changes:
- Adds
global.required.ai.openAiKeyFreeandglobal.required.ai.openAiKeySweto the evaluator values overlay YAML snippet. - Adds explanatory comments describing the symptom (scan stuck at “Scanning in progress”) and the related worker log error.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+397
to
+399
| # AI piloting keys — required for the worker's AI enrichment pipeline. | ||
| # Without these, scans hang at "Scanning in progress" with worker logs | ||
| # showing `openai.OpenAIError: The api_key client option must be set`. |
Comment on lines
+402
to
+403
| openAiKeyFree: &oaiKeyFree "<to-fill>" | ||
| openAiKeySwe: &oaiKeySwe "<to-fill>" |
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.
Summary
global.required.aiblock (openAiKeyFree+openAiKeySwe) to the values overlay in step 9 of the Evaluator Installation guide.docs/self-hosted/local-evaluation.mdx.Test plan
pnpm build(or local dev server) and confirm the page renders.&oaiKeyFree/&oaiKeySweparse correctly).🤖 Generated with Claude Code