Repository navigation
docs(docker): fix Compose environment quoting in all locales - #195
Merged
Merged
Conversation
Use environment mapping syntax so addresses and the log directory do not contain literal shell quotes. Align the service bind mounts with the permissions initializer across de, en, fr, ja, and zh. Co-Authored-By: heihutu <heihutu@gmail.com> Co-Authored-By: zhi22915 <qiuzgang@gmail.com>
This was referenced Nov 6, 2026
Deploying with
|
| Status | Name | Latest Commit | Preview URL | Updated (UTC) |
|---|---|---|---|---|
| ✅ Deployment successful! View logs |
rustfs-docs | a320847 | Commit Preview URL Branch Preview URL |
Nov 06 2026, 03:19 PM |
houseme
requested review from
majinghe
and
a balanced review from Copilot
and removed request for
Copilot
November 6, 2026 15:22
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.
Related Issues
Fixes the documentation cause of rustfs/rustfs#9192. Tracking: rustfs/backlog#3161. Related startup diagnostics: rustfs/rustfs#9201.
Summary of Changes
The Docker Compose example uses list entries such as
RUSTFS_OBS_LOG_DIRECTORY="/var/log/rustfs/". Compose passes those inner quotes literally, so the entrypoint tries to create a relative path beginning with"and fails before RustFS starts. The two listen addresses have the same problem.Use YAML environment mappings in the German, English, French, Japanese and Chinese Docker pages. Also make the data/log bind mounts use the same host parent directory as the permissions initializer; the old paths differed by a slash and underscore, so the initializer could grant ownership to a different directory.
Verification
npm run docs:check,npm run build, andgit diff --checkpassed. Checked the generated HTML for all five Docker pages to confirm it contains the corrected configuration.npm run types:checkreports 18 existing TS7006 errors. Running the same command on unchanged main produces exactly the same diagnostics. The locale audit (node .agents/skills/localize-rustfs-docs/scripts/audit-locales.mjs --locales de,fr,ja,zh) also has identical before/after results: 54 errors and 177 warnings outside this change.No full container startup was run because no Docker daemon is available. The original directory permission failure was reproduced with the actual upstream entrypoint in a non-writable working directory.
Impact
Corrects executable examples across all five locales without changing prose, routes or site code. Existing shell
docker run -e NAME="value"examples retain their valid shell quoting. Literal quotes in user credentials remain meaningful; the runtime does not strip them. Independent final-diff review found no issues.Additional Notes
rustfs/rustfs#9162 adds bucket bootstrap after directory initialization and does not resolve this error. XFS remains the recommended production filesystem; this failure is caused by configuration bytes before the data filesystem is opened. Rollback restores the old documentation examples only.