docs: add dhi image docs#407
Conversation
How to use the Graphite Merge QueueAdd the label merge-queue to this PR to add it to the merge queue. You must have a Graphite account in order to use the merge queue. Sign up using this link. An organization admin has enabled the Graphite Merge Queue in this repository. Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue. This stack of pull requests is managed by Graphite. Learn more about stacking. |
|
Preview deployed successfully! Built from commit c5c0833 |
| "env": "ARCANE_DEFAULT_NONROOT", | ||
| "field": "DefaultNonRoot", | ||
| "type": "bool", | ||
| "defaultValue": "false", | ||
| "description": "Enable the official images to drop from root to the default non-root runtime user when PUID/PGID are not set.", | ||
| "source": "config.Config", | ||
| "sourceFile": "backend/internal/config/config.go", | ||
| "sourceSymbol": "config.Config.DefaultNonRoot" | ||
| }, |
There was a problem hiding this comment.
defaultValue contradicts documented official-image behavior
config.json records "defaultValue": "false" for ARCANE_DEFAULT_NONROOT, so the generated <EnvTable /> on the Environment Variables page will show users that this setting defaults to false. However, environment.md (added in this same PR) explicitly states "Official Arcane images set ARCANE_DEFAULT_NONROOT=true", and installation.md says images "drop to a non-root runtime user by default."
A user reading the env table alongside the prose will encounter contradictory signals about what the actual default behavior is. If official images hardcode ARCANE_DEFAULT_NONROOT=true in the Dockerfile or entrypoint, that distinction should be surfaced — either by noting in the description that the code default differs from the image default, or by adjusting defaultValue to reflect the shipped-image default and documenting the code-level fallback separately.
Prompt To Fix With AI
This is a comment left during a code review.
Path: static/config.json
Line: 78-86
Comment:
**`defaultValue` contradicts documented official-image behavior**
`config.json` records `"defaultValue": "false"` for `ARCANE_DEFAULT_NONROOT`, so the generated `<EnvTable />` on the Environment Variables page will show users that this setting defaults to `false`. However, `environment.md` (added in this same PR) explicitly states "Official Arcane images set `ARCANE_DEFAULT_NONROOT=true`", and `installation.md` says images "drop to a non-root runtime user by default."
A user reading the env table alongside the prose will encounter contradictory signals about what the actual default behavior is. If official images hardcode `ARCANE_DEFAULT_NONROOT=true` in the `Dockerfile` or entrypoint, that distinction should be surfaced — either by noting in the description that the code default differs from the image default, or by adjusting `defaultValue` to reflect the shipped-image default and documenting the code-level fallback separately.
How can I resolve this? If you propose a fix, please make it concise.
Disclaimer Greptiles Reviews use AI, make sure to check over its work.
To better help train Greptile on our codebase, if the comment is useful and valid Like the comment, if its not helpful or invalid Dislike
To have Greptile Re-Review the changes, mention
greptileai.Greptile Summary
This PR adds documentation for Arcane 1.19.2, focusing on the new non-root container runtime user feature and updated image variant descriptions.
ARCANE_DEFAULT_NONROOT,PUID/PGID, andDOCKER_HOSTsocket-group behavior; adds a matching entry forARCANE_DEFAULT_NONROOTinconfig.json.next-images.mdto reflect that thenexttag now uses a hardened Debian-based runtime (replacing the previous Alpine/distroless description), and documents whatnext-static/next-distrolessare suited for.Confidence Score: 3/5
The docs change is largely accurate, but a contradiction between the generated env table (defaultValue: false) and the prose (official images set it to true) will be visible to users and could cause confusion about the actual out-of-the-box behavior.
The ARCANE_DEFAULT_NONROOT entry in config.json carries defaultValue false, so the auto-generated Environment Variables table will show this setting as off by default. Meanwhile, the new prose in environment.md and installation.md tells users that official images have it set to true and that Arcane drops to a non-root user by default. Users reconciling those two signals are likely to be misled about whether they need to set the variable explicitly in their own deployments.
static/config.json and content/configuration/environment.md need to agree on what the effective default is for users of official images.
Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: docs for 1.19.2" | Re-trigger Greptile