docs: P0 — fix factual errors, dangerous ops guidance, leftover test content - #99
Merged
Merged
Conversation
…ontent - Remove fabricated CLI commands (rustfs-admin, rc) and nonexistent config files (config.toml/config.yaml) - Fix disk-replacement guide: mkfs.ext4 -> mkfs.xfs, align mount points with install layout - Fix expansion guide: unify RUSTFS_VOLUMES hostname patterns, correct rolling-restart semantics, systemd TimeoutStartSec 30s -> 120s (matches upstream unit) - Correct console port 9090 -> 9001; open 9001 in firewall sections; document desktop launcher port 7001 vs server default 9001 - concepts/limit: single PUT 500 GiB -> 5 GiB; fix EC read/write quorum formulas - erasure-coding: Blake3 -> HighwayHash256 (matches bitrot implementation) - logging: resolve Prometheus self-contradiction; remove nonexistent Operator/LogSearch/Elasticsearch/NSQ, add Pulsar - nginx: add TLS directives to 443 example; move S3 off path prefix (SigV4 breaks under /api) - Replace hand-signed SigV4 curl examples with aws s3api; drop private paths and password.txt samples - mcp: warn that crates/mcp moved out of the main repo; HTTPS clone URLs - Remove leftover test page content/deep; drop io_uring claims that contradict upstream; remove Serf/VxLAN port requirements; fix broken #mode anchors; remove 100%-secure/100%-compatible claims
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
docs-rustfs-com | 836a2b0 | Commit Preview URL Branch Preview URL |
Jul 15 2026, 07:01 AM |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This was referenced Jul 15, 2026
overtrue
pushed a commit
to jstangroome/docs.rustfs.com
that referenced
this pull request
Jul 16, 2026
By default nginx sends a Connection: close request header upstream, which breaks upstream keepalives (latency from repeated TCP handshakes, port exhaustion under load). An http_upgrade map sends a blank Connection header to preserve keepalives, or Connection: upgrade when the client requests a websocket upgrade. Rebased onto content/integration/nginx.md after the VitePress to FumaPress migration and the rustfs#99 restructure.
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 (review workstream: P0 accuracy & safety — rustfs/backlog#1277)
Fixes the highest-risk factual errors and dangerous operational guidance found in the docs review (25 files + 1 test directory removed).
Dangerous guidance (following it caused incidents):
mkfs.ext4→mkfs.xfs; mount points aligned with the install layout (healing never triggered as written)RUSTFS_VOLUMEShostname patterns across old/new nodes (as written, the whole cluster failed to start); "rolling restart prohibited" narrowed to "only pool changes need a full restart"; systemdTimeoutStartSec30s → 120s (matches the upstream unit; 30s causes kill-restart loops on cold start)/apipath prefix (SigV4 breaks under a prefix); replaced the conflictingConnectionheader pairs with an$http_upgrademap so upstream keepalives survive while websocket upgrades still work — incorporates Fix nginx websocket and keepalive support #76 by @jstangroome (the original PR targets the pre-migrationdocs/path)Fabricated content removed:
rustfs-admin/rccommand families (self-described as "hypothetical"), nonexistentconfig.toml/config.yaml, nonexistent Operator/LogSearch/Elasticsearch/NSQ (real Pulsar target added);developer/mcp.mdnow warns thatcrates/mcpmoved out of the main repo.Hard numbers corrected: single PUT limit 500 GiB → 5 GiB (the old number was MinIO's); EC read/write quorum formulas (read = N−parity, write = data shards); Blake3 → HighwayHash256; console port 9090 → 9001; desktop launcher port 7001 documented as distinct from the server default 9001; io_uring claims aligned with source (opt-in, off by default).
Hygiene: hand-signed SigV4 curl examples →
aws s3api; private paths /password.txt/ realistic-looking access keys / SSH clone URLs removed; leftover test pagecontent/deep/deleted; broken#modeanchors fixed; "100% secure / 100% S3 compatible" claims removed.Every correction is backed by a source citation (file:line) in the review reports (see the nav PR's
docs-review/). Build: ✓ 355 pages.Backed by the multi-role docs review (master issue rustfs/backlog#1277; six full reports ship in the nav PR under
docs-review/). Technical facts verified against rustfs/rustfs@ea2e24ac.Rendered page previews (before / after)
/concepts/limit/concepts/principle/erasure-coding/developer/mcp/installation/checklists/network-checklists/installation/checklists/security-checklists/installation/checklists/software-checklists/installation/linux/multiple-node-multiple-disk/installation/linux/single-node-multiple-disk/installation/linux/single-node-single-disk/integration/nginx/integration/tls-configured/integration/virtual/management/bucket/creation/management/bucket/deletion/management/object/creation/management/object/deletion/troubleshooting/driver/troubleshooting/healing/troubleshooting/node/upgrade-scale/availability-and-resiliency/features/encryption(new page)/features/logging(new page)/installation/linux(new page)/installation/macos(new page)/installation/windows(new page)