Repository navigation
docs: fix invalid server config examples (dashboard section, proxyAccessLog placement) - #561
Open
almeidapaulopt wants to merge 1 commit into
Open
almeidapaulopt wants to merge 1 commit into
almeidapaulopt wants to merge 1 commit into
Conversation
The getting-started examples (current and v3) showed a `dashboard:` server-config section and `proxyAccessLog` nested under `log:`. Neither exists in the server config: `adminAllowLocalhost` and `proxyAccessLog` are top-level settings, and `dashboard:` is only valid inside preset templates. With strict config loading these examples fail to boot (v2) or silently drop the settings (v3). Fixes the example in getting-started.md, v3/getting-started.md, and the v3 from-v2 upgrade guide. Refs #559
This was referenced Nov 13, 2026
This branch has not been deployed
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.
What
Fixes the server-config YAML examples in three docs pages:
docs/content/docs/getting-started.mddocs/content/docs/v3/getting-started.mddocs/content/docs/v3/upgrading/from-v2.mdThe examples showed a
dashboard:server-config section andproxyAccessLognested underlog:. Neither exists in the server config:adminAllowLocalhostandproxyAccessLogare top-level settings (internal/config/config.go,Data)dashboard:is only valid inside preset templates (PresetDashboard)With strict config loading, the old examples refuse to boot on v2.3.4 and silently drop the settings on v3/main.
Refs #559
Verification
Reproduced against the v2.3.4 strict loader (
yaml KnownFields(true)), which users run today:The fixed example loads on v2.3.4 with every documented setting applying (
adminAllowLocalhost,proxyAccessLog,log.level,log.json,tailscale.dataDir, providercontrolUrl).On
main, everytsdproxy.yamlfence in the three edited pages was extracted and loaded throughunmarshalNormalized; all load and apply their settings.Notes
A follow-up PR tightens the v3 loader: misplaced keys that are known elsewhere in the schema are currently silently dropped on main (v2.3.4 rejected them) — filed separately.