docs: clarify partial local server configs - #765
Merged
Conversation
sdairs
force-pushed
the
docs/local-config-overlays
branch
from
September 7, 2026 13:15
ca44a63 to
e44d769
Compare
sdairs
marked this pull request as ready for review
September 7, 2026 13:17
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.
Stacked on #756 (
docs/755-readme-products).local server start --configwas described as a custom config file at the point of use, making it easy to assume a complete default config was required. The flag and empty config-list guidance now explain that files contain only changed settings and inherit the remaining defaults.The README demonstrates server and profile settings in one overlay, explains how to use an existing
config.dfragment, and documents source edits, restart selection, generated output, and file lookup. Help keeps the short operational guidance; config loading and JSON output are unchanged.Closes #764.
Validation (run before restacking; patch unchanged):
cargo fmt --allandgit diff --checkcargo clippy -p clickhousectl -- -D warningscargo test -p clickhousectl: one existing port-dependent stderr assertion fails (details below); all other executed tests pass, with one ignored test.cargo test -p clickhousectl --test local_version_error_test --test telemetry_testcovers the binaries the full run stopped before reaching.cargo check -p clickhousectl --no-default-featurescargo clippy -p clickhousectl --all-targets --no-default-features -- -D warningsLocal test limitation:
config_and_argument_failures_carry_their_full_human_detail_in_jsonfails because OrbStack already listens on 8123 and 9000. The CLI emitsNote: default ports in use, auto-assigned HTTP:8124 TCP:9001before the missing-config error, while the unchanged test expects only the error. A focused rerun reproduces it. The change does not touch port selection or error rendering.Restacking validation:
git range-diffconfirms the same single-commit patch;cargo fmt --allandgit diff --checkpass on the new base.