Correctly document the default for dns.override_local_dns

[dotlambda]

See https://github.com/juanfont/headscale/pull/2438#discussion_r2046953908.

• [x] have read the CONTRIBUTING.md file
• [ ] raised a GitHub issue or discussed it on the projects chat beforehand
• [ ] added unit tests
• [ ] added integration tests
• [x] updated documentation if needed
• [ ] updated CHANGELOG.md

[ghost]

Pull Request Revisions

Revision	Description
r1	DNS configuration default changed Modified override_local_dns default from false to true in config-example.yaml

---

✅ AI review completed for r1

Help

React with emojis to give feedback on AI-generated reviews:

• 👍 means the feedback was helpful and actionable
• 👎 means the feedback was incorrect or unhelpful

💬 Replying to feedback with a comment helps us improve the system. Your input also contributes to shaping future interactions with the AI reviewer.

We'd love to hear from you—reach out anytime at [email protected].

[dotlambda]

we should change the default value in case the option dns.override_local_dns is missing in the configuration instead.

Sure but that would be another breaking change.

[nblock]

Sure but that would be another breaking change.

Good point, depends on who you ask. Changing the default in the config is a breaking change for users that either started using Headscale with 0.26.0 or upgraded and migrated the config.

Changing the fallback value in the code is a breaking change for users that upgraded but did not migrate the configuration while upgrading to 0.26.0.

@kradalby what is your take?

[nblock]

Sure but that would be another breaking change.

Let's go with your suggestion. Thx for bringing it up!

[nblock]

@dotlambda could you please rebase and force-push? Github CI seems to be broken again :(