docs(config): document temp_upload server config + ovcli.conf upload.mode (#1899)#1925
Merged
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
May 9, 2026
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
#1899 (feat(server): add shared temp upload mode by @zhoujh01, merged 2026-05-08T03:12Z) introduces two new public config surfaces, but
docs/{en,zh}/guides/01-configuration.md(the canonical config reference) was not updated:server.temp_upload(inov.conf) — new block withdefault_mode/shared_max_size_bytes/shared_prefix. Source of truth:openviking/server/config.py:98-105(TempUploadConfig).upload.mode(inovcli.conf) — new optional client field selecting"local"vs"shared"per request, also overridable viaOPENVIKING_UPLOAD_MODE. Source of truth:openviking_cli/utils/config/ovcli_config.py:18(OVCLIUploadConfig.mode).#1899 already added these to API docs (
docs/{en,zh}/api/{01-overview,02-resources,04-skills}.mdetc.), but operators landing on the central config reference would not learn either field exists.What this PR does
EN + ZH dual-doc mirror, ~10 LOC additive each, single section pair (no relocation, no deletions):
ovcli.confexample: add"mode": "local"(safe default) to theuploadblock + addupload.moderow to the field table with both modes explained and theOPENVIKING_UPLOAD_MODEenv override called out.ov.confserversection example: add thetemp_uploadblock alongsidecors_origins+ add 3 rows to the field table fortemp_upload.default_mode,temp_upload.shared_max_size_bytes,temp_upload.shared_prefix.Defaults verified against
server/config.py("local"/536870912bytes /"viking://upload").Why this scope
"mode": "local"(the safe default), so copy-paste does not silently opt single-node users into distributed shared-store behavior.observability,storage.transaction, etc., and looks intentionally trimmed; bringingtemp_uploadthere alone would be inconsistent.Test plan
upload.modeandserver.temp_upload.*."local",536870912,"viking://upload") still matchopenviking/server/config.pyTempUploadConfig.If any wording on the shared-mode caveat ("required when consumer requests can land on a different server instance") undersells or oversells the cross-replica requirement, happy to tighten.