Skip to content

docs: document RUSTFS_CHECK_UPDATE in environment variables reference - #167

Merged
majinghe merged 1 commit into
rustfs:mainfrom
majinghe:docs/env-check-update
Oct 5, 2026
Merged

majinghe merged 1 commit into
rustfs:mainfrom
majinghe:docs/env-check-update

Conversation

@majinghe

@majinghe majinghe commented Oct 5, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Add the RUSTFS_CHECK_UPDATE startup update-check toggle to the Core server table of the Environment Variables reference, right after RUSTFS_STARTUP_READINESS_MAX_WAIT_SECS.
  • Documented behavior: default true; at startup the server sends a single HTTPS request to version.rustfs.com (the user agent carries the current version); the result is logged only and RustFS never updates itself; false skips the outbound request (useful for air-gapped deployments); unrecognized values fall back to true.

Changes

  • content/{en,de,fr,ja,zh}/reference/environment-variables.md — one table row each. de/fr/ja keep the English table (those pages are not translated yet); zh is translated.

Verification

Every fact was verified against the rustfs/rustfs source, not inferred from existing docs:

  • Default value: crates/config/src/constants/console.rs (DEFAULT_UPDATE_CHECK = true)
  • Startup check, skip behavior, and fallback for unrecognized values: rustfs/src/init.rs (init_update_check)
  • Request target and user agent: rustfs/src/update.rs (version.rustfs.com/latest.json, RustFS/<version>)
  • No matching command-line flag exists (checked rustfs/src/config/cli.rs)

Checks run:

  • npm run docs:check — PASS (orphans, broken links, unlabeled fences, banned strings, oversized images, locale tree parity, translated code blocks)
  • npm run build — OK (3,495 files generated)
  • node .agents/skills/localize-rustfs-docs/scripts/audit-locales.mjs --locales de,fr,ja,zh — no new findings (pre-existing untranslated-page findings unchanged, verified with a stash comparison)

Locales

en, de, fr, ja, zh

Add the startup update-check toggle to the Core server table in all
five locales (de/fr/ja keep the English table as before; zh translated).
Verified against rustfs/rustfs source: default true
(crates/config/src/constants/console.rs), startup check and fallback
behavior (rustfs/src/init.rs), request target and user agent
(rustfs/src/update.rs).
@vercel

vercel Bot commented Oct 5, 2026

Copy link
Copy Markdown

@majinghe is attempting to deploy a commit to the overtrue's projects Team on Vercel.

A member of the Team first needs to authorize it.

@majinghe
majinghe merged commit 36dbec1 into rustfs:main Oct 5, 2026
1 of 2 checks passed
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.

1 participant