oldest client supported, not latest

[kradalby]

Closes #2070

Summary by CodeRabbit

• Documentation Updates
  • Revised the changelog to clarify client compatibility, now indicating the oldest supported client version.
  • Updated the requirement for DERP configuration at startup to prevent server issues.
  • Removed information regarding support for multiple IP ranges in the README, potentially affecting user understanding of network configuration options.

[coderabbitai]

Walkthrough

The recent changes to the Headscale application include updates to the client support documentation, clarifying that the oldest supported client is version 1.42. Additionally, the requirement for at least one DERP to be defined at startup has been emphasised, alongside the need for a private key for the embedded DERP server. A line regarding multiple IP ranges in the tailnet has been removed from the README, indicating a potential change in feature support.

Changes

Files	Change Summary
CHANGELOG.md	Updated client support description from "latest supported" to "oldest supported" client version. Emphasised requirement for DERP configuration at startup and private key for embedded DERP server.
README.md	Removed line indicating support for multiple IP ranges in the tailnet.

Assessment against linked issues

Objective	Addressed	Explanation
Clarify client support version (2070)	✅
Update documentation for DERP requirements (2070)	✅
Remove outdated feature support (2070)	✅

Poem

In the meadow where I hop and play,
Changes come to brighten the day.
With clients old, we dance in cheer,
DERP's secure, no need to fear!
Hooray for updates, let’s all unite,
A tailnet's joy, oh what a sight! 🐇✨

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 76515d1 and 7ac2cdb.

Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• README.md (1 hunks)

Files skipped from review due to trivial changes (1)

• README.md

Additional comments not posted (3)

CHANGELOG.md (3)

32-32: Clarification on supported client versions approved.

The change to specify that "the oldest supported client is 1.42" is clear and addresses the concerns raised in the PR. This should help ensure users are aware of the minimum client version supported, rather than the maximum.

---

32-32: Requirement for DERP configuration at startup approved.

The clarification that at least one DERP must be defined at startup is crucial for ensuring the server operates correctly. This prevents potential runtime issues due to misconfiguration.

---

32-32: Enhanced security for embedded DERP server approved.

The requirement for a private key for the embedded DERP server is a positive change, enhancing the security of the server setup.