docs(bot): sync gateway config example with #1640 security defaults#1649
Merged
qin-ctx merged 1 commit intovolcengine:mainfrom Apr 23, 2026
Merged
Conversation
PR Reviewer Guide 🔍Here are some key observations to aid the review process:
|
PR Code Suggestions ✨No code suggestions found for the PR. |
qin-ctx
approved these changes
Apr 23, 2026
Collaborator
|
thanks! |
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.
Description
Sync the
bot.gatewayconfig example and notes inbot/docs/rfc-openviking-cli-ov-chat.mdwith the security defaults introduced by #1640 (fix(bot):Fix bot api-channel auth check, merged 2026-04-22):hostdefault changed from"0.0.0.0"to"127.0.0.1"— matches the newGatewayConfig.hostdefault inbot/vikingbot/config/schema.pyand the hardened server startup path inopenviking/server/bootstrap.py.token: ""field to the example —GatewayConfig.tokenis the canonical replacement for the deprecatedapi_key, and is used for theX-Gateway-Tokenproxy auth header.bot.gatewaybullet to describe the fail-fast contract (requires_gateway_token): when the gateway binds to a non-localhost host, a non-emptytokenis mandatory or startup fails.Without this doc sync, users copy-pasting the sample JSON from the RFC will (a) accidentally bind the gateway to
0.0.0.0contrary to the new safe default, and (b) hit the fail-fast token check at startup with no docs context.Related Issue
Docs drift from #1640 (merged 2026-04-22 by @chenjw). No open issue.
Type of Change
Check of the Task
GatewayConfig, server/config.pyload_bot_gateway_token, server/bootstrap.py fail-fast) to confirm the new contractgrepconfirmsbot/docs/rfc-openviking-cli-ov-chat.mdis the only doc carrying the now-outdatedbot.gatewayexample (bot/docs/CHANNEL.mddoes not referencebot.gateway)