docs: document web_search_provider and cloud_* keys in config example#195
Open
ayobamiseun wants to merge 1 commit into
Open
docs: document web_search_provider and cloud_* keys in config example#195ayobamiseun wants to merge 1 commit into
ayobamiseun wants to merge 1 commit into
Conversation
config.example.toml covered 7 of the 13 supported keys; a user reading it could not discover how to switch web-search providers or point a dev/BYO deployment at its own cloud instance. Adds web_search_provider (with the three supported backends) and the cloud_* family (commented out — the defaults are the production values, and an empty cloud_relay_ws_url meaningfully disables the relay). Also notes the Windows global config location and that allowed_commands/auto_allow are global-only until workspace trust. Verified: the example parses with tomllib and every key (including the commented cloud_* names) matches coworker.config._FIELDS.
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.
What
docs/config.example.tomldocumented 7 of the 13 config keyscoworker/config.pysupports. A user reading the example could not discover:web_search_provider— how to switch betweenduckduckgo(keyless default),tavily, andbrave(coworker/config.py:40-41). There is also no GUI setting for this yet ([UX] No GUI settings for web search provider #51), so the config file is currently the only way to change it — and it was undocumented.cloud_*family (cloud_base_url,cloud_auth_domain,cloud_client_id,cloud_audience,cloud_relay_ws_url) — needed by dev/staging/BYO-VPC deployments, and relevant to users asking how to minimize the cloud dependency (Will it be possible to skip OpenWorker cloud? #54): settingcloud_relay_ws_url = ""disables the relay. Added commented-out, since the defaults are the production values.Also two small accuracy notes in the header: the Windows global config location (
%APPDATA%\coworker\config.toml, percoworker/secrets.py:32), and thatallowed_commands/auto_alloware honored from the global file only until workspace trust (per_GLOBAL_ONLY_FIELDS,coworker/config.py:80).Before / after
Before — keys documented:
model,mode,max_iterations,allowed_commands,auto_allow,host,port.After — adds:
Verification
tomllib.cloud_*name checked againstcoworker.config._FIELDS— no unknown keys.