Update documentation for 0.23

[nblock]

The goal is to update the documentation for the upcoming 0.23 release with minimal changes and (mostly) add one commit per file.

Other issues such as duplicate instructions in multiple files are not addressed as those require some discussions with the maintainers beforehand.

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

Fixes: #2090
Fixes: #1822

Summary by CodeRabbit

Summary by CodeRabbit

• Documentation
  • Updated ACL configuration documentation to reflect a change in the parameter name from acl_policy_path to policy.path, enhancing clarity for users.
  • Revised exit node documentation to replace "Machine" with "Node" for improved consistency and readability, and simplified a URL by removing unnecessary query parameters.
  • Enhanced formatting and readability of shell command examples in the remote CLI documentation.
  • Made minor textual modifications in the reverse proxy documentation for clarity and grammatical accuracy.
  • Clarified instructions for running the Headscale Docker container, including updates to command references and placeholder formats.
  • Improved clarity and presentation in the Linux running documentation, including a more prominent warning format.
  • Corrected typographical errors and improved clarity in the OpenBSD running documentation.
  • Updated Sealos documentation to remove specific version references, promoting access to the latest templates.

[coderabbitai]

Walkthrough

The documentation for Headscale has been updated to reflect changes in parameter names and terminology for clarity. Specifically, acl_policy_path has been changed to policy.path in the configuration file. Additionally, the term "Machine" has been replaced with "Node" in the exit node context documentation. Various formatting adjustments have also been made to enhance readability. These updates maintain the same underlying functionality.

Changes

Files	Change Summary
docs/acls.md, docs/exit-node.md	Updated parameter name from acl_policy_path to policy.path and replaced "Machine" with "Node" for consistency in terminology.
docs/remote-cli.md	Adjusted formatting for shell command examples and standardised the term "environment variables."
docs/reverse-proxy.md	Minor textual modifications for clarity, including enhancements to WebSockets support explanation.
docs/running-headscale-container.md, docs/running-headscale-linux-manual.md, docs/running-headscale-openbsd.md, docs/running-headscale-sealos.md	Clarified instructions, removed outdated steps, and corrected placeholders for consistency across various setup guides.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Headscale
    participant Config

    User->>Config: Update configuration
    Config->>Headscale: Load ACL from policy.path
    Headscale->>User: Apply ACL settings

Loading

Poem

In the meadow, changes bloom,
A path to policies, no more gloom.
From acl to policy, a clearer way,
Hopping forward, we cheer and play!
With every leap, our rules align,
A joyful dance, all will be fine! 🐇✨

---

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.

Early access features: disabled

We are currently testing the following features in early access:

• Anthropic claude-3-5-sonnet for code reviews: Anthropic claims that the new Claude model has stronger code understanding and code generation capabilities than their previous models. Note: Our default code review model was also updated late last week. Please compare the quality of the reviews between the two models by toggling the early access feature.

Note:

• You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file.
• Please join our Discord Community to provide feedback and report issues on the discussion post.

[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 ed71d23 and 87f3f24.

Files selected for processing (1)

• docs/acls.md (1 hunks)

Files skipped from review due to trivial changes (1)

• docs/acls.md

[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 87f3f24 and 052e675.

Files selected for processing (2)

• docs/acls.md (1 hunks)
• docs/exit-node.md (2 hunks)

Files skipped from review due to trivial changes (1)

• docs/exit-node.md

Files skipped from review as they are similar to previous changes (1)

• docs/acls.md

[nblock]

As per 1193a50, the oldest support Tailscale client version is 1.42. The documentation and the OS specific endpoints /apple and /windows distinguish between various versions; all of them older than 1.42.

Can I just get rid of this and assume 1.42+? This would remove some probably useless and no longer required instructions in the documentation and also from the OS specific endpoints /apple and /windows.

[coderabbitai]

Actionable comments posted: 2

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 052e675 and a1cd803.

Files selected for processing (4)

• docs/acls.md (1 hunks)
• docs/exit-node.md (2 hunks)
• docs/remote-cli.md (1 hunks)
• docs/reverse-proxy.md (2 hunks)

Files skipped from review due to trivial changes (1)

• docs/acls.md

Files skipped from review as they are similar to previous changes (1)

• docs/exit-node.md

Additional context used

LanguageTool

docs/remote-cli.md

[grammar] ~71-~71: Did you mean “you are”, “yours are” or “your”?
Context: ...The API key is needed to make sure that your are allowed to access the server. The key i...

(YOUR_RE)

docs/reverse-proxy.md

[grammar] ~83-~83: The verb “add” needs to be in the to-infinitive form.
Context: ...ails upgrade_failed ``` ### Envoy You need add a new upgrade_type named `tailscale-con...

(MISSING_TO_BEFORE_A_VERB)

Additional comments not posted (5)

docs/remote-cli.md (4)

50-52: Improved code block formatting.

The adjustment to the indentation of the shell command example enhances the readability of the instructions.

---

56-59: Improved code block formatting.

The adjustment to the indentation of the shell command example enhances the readability of the instructions.

---

63-66: Improved code block formatting.

The adjustment to the indentation of the shell command example enhances the readability of the instructions.

---

78-80: Improved code block formatting.

The adjustment to the indentation of the shell command example enhances the readability of the instructions.

docs/reverse-proxy.md (1)

14-14: Approved: The added phrase clarifies the purpose of WebSockets support.

The change enhances the explanation by specifying that WebSockets support is required to communicate with Tailscale clients.

[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 a1cd803 and d6e65c9.

Files selected for processing (6)

• docs/remote-cli.md (1 hunks)
• docs/reverse-proxy.md (2 hunks)
• docs/running-headscale-container.md (8 hunks)
• docs/running-headscale-linux-manual.md (2 hunks)
• docs/running-headscale-openbsd.md (3 hunks)
• docs/running-headscale-sealos.md (2 hunks)

Files skipped from review due to trivial changes (4)

• docs/remote-cli.md
• docs/reverse-proxy.md
• docs/running-headscale-openbsd.md
• docs/running-headscale-sealos.md

Additional context used

Markdownlint

docs/running-headscale-container.md

160-160: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

---

160-160: Expected: indented; Actual: fenced
Code block style

(MD046, code-block-style)

Additional comments not posted (6)

docs/running-headscale-linux-manual.md (2)

3-6: Improved warning note formatting and phrasing.

The changes to the warning note are approved for the following reasons:

• The reformatting to a more prominent warning block enhances visibility for users.
• The reformatting of the phrase "Outdated and advanced" to a warning format emphasises the caution regarding the documentation's relevance.
• The rephrasing to include a direct link to the distro-specific documentation improves navigability for users seeking current information.

---

5-6: Verify the impact of removing the SQLite database creation section.

The section detailing the creation of an empty SQLite database has been removed. Please verify the following:

• Is this step no longer necessary for setting up and running headscale on Linux?
• Has this information been relocated to another part of the documentation?
• Will removing this section have any unintended consequences for users following this guide?

To verify the impact of this change, please provide additional context or confirm that the removal of this section is intentional and will not negatively affect users.

docs/running-headscale-container.md (4)

55-55: LGTM!

The change simplifies the command and enhances readability without affecting the functionality.

---

70-70: LGTM!

The changes standardise the placeholder format and allow for easier updates in the future without affecting the functionality.

Also applies to: 77-78

---

105-105: LGTM!

The change simplifies the command and enhances readability without affecting the functionality.

---

120-120: LGTM!

The changes reflect updates to the container's internal structure and enhance consistency without affecting the functionality.

Also applies to: 148-148, 158-158, 161-161

[kradalby]

As per 1193a50, the oldest support Tailscale client version is 1.42. The documentation and the OS specific endpoints /apple and /windows distinguish between various versions; all of them older than 1.42.

Can I just get rid of this and assume 1.42+? This would remove some probably useless and no longer required instructions in the documentation and also from the OS specific endpoints /apple and /windows.

Yes please!

Quick look at /apple, I think all the mentions of versions can be removed, I think that the profile and defaults stuff can still stay around as it does work still, and to some this might be preferred to force it to always try headscale first, but restructuring make sense.

Same for /windows, the registry stuff is useful, but dont need to distinguish the versions anymore, if you are up for it that would be great.

Preferably do it as a followup PR.

[kradalby]

Thank you!, these changes are incredibly helpful!

Two small changes, I might have confused myself gotten it the wrong way around with docker, but right now the serve and user example is not calling docker the same way.

[nblock]

Preferably do it as a followup PR.

Thx for the feedback; will submit a new PR for this later.