Skip to content

docs(s3): clarify download transfer modes - #368

Merged
ILoveScratch2 merged 1 commit into
OpenListTeam:mainfrom
nostalume:docs/s3-transfer-modes
Sep 10, 2026
Merged

ILoveScratch2 merged 1 commit into
OpenListTeam:mainfrom
nostalume:docs/s3-transfer-modes

Conversation

@nostalume

Copy link
Copy Markdown
Contributor

Description / 描述

  • Clarify that ordinary S3 object downloads may use an HTTP 302 redirect when proxying is not required and the storage provides a direct URL.
  • Explain when OpenList relays the response through the local server, including the target storage's Web Proxy setting.
  • Document the bandwidth and client-compatibility tradeoff, with a conservative recommendation for repository tools such as restic and rustic.
  • Keep the English and Chinese guidance aligned.

Motivation and Context / 背景

The existing guide says that every S3 download is relayed locally. Current OpenList behavior can instead redirect an eligible ordinary object download to the storage provider, so operators cannot reliably choose between direct and relayed transfers from the current documentation.

Relates to OpenListTeam/OpenList#2796

Validation / 验证

  • prettier --check pages/guide/advanced/s3.md — passed with the repository-pinned Prettier 3.6.2.
  • git diff --check — passed.
  • NODE_OPTIONS='--max-old-space-size=8192' valaxy build --ssg — passed in Git Bash; the generated S3 page contains both updated language sections and the existing section anchors.
  • pnpm format:check — the modified S3 page passes, but the repository-wide command reports 179 pre-existing files outside this change.
  • The native Windows pnpm build wrapper reaches build:ssg but cannot parse its POSIX-style NODE_OPTIONS=... assignment; the equivalent SSG command above completed successfully.

Checklist / 检查清单

  • I have read the CONTRIBUTING document.
    我已阅读 CONTRIBUTING 文档。
  • I have formatted my code or documentation with prettier or another appropriate formatter.
    我已使用 prettier 或其它适当的格式化工具格式化提交的文档。
  • I have updated all supported languages (including Chinese and English) for documentation.
    我已为所有支持语言(包括中文和英文)更新文档内容。
  • I have verified that the written documentation is properly formatted and builds without page syntax errors.
    我已确认文档格式正确,并且可以构建且不存在页面语法错误。
  • I have updated the related repository as needed.
    我已按需更新相关仓库。

@ILoveScratch2
ILoveScratch2 merged commit a0143d9 into OpenListTeam:main Sep 10, 2026
@nostalume

Copy link
Copy Markdown
Contributor Author

@ILoveScratch2 There's another pr of slow-down error code of s3 at add S3 SlowDown error of gofakes3 repo. I recommend review that too, because only after that we can develop s3 handling

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants