starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-14 05:03:28 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

[PR #2096] [MERGED] Update documentation for 0.23 #2493

New Issue
Closed
opened 2025-12-29 03:21:31 +01:00 by adam · 0 comments
adam commented 2025-12-29 03:21:31 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2096
Author: @nblock
Created: 9/1/2024
Status: ✅ Merged
Merged: 9/3/2024
Merged by: @kradalby

Base: main ← Head: docs-0.23

📝 Commits (9)

  • 87b68c5 docs/acl: fix path to policy file
  • 0047222 docs/exit-node: fixup for 0.23
  • 40c7911 docs/remote-cli: fix formatting
  • 3f9b95d docs/reverse-proxy: remove version information
  • cbc1bd3 docs/exit-node: add warning to manual documentation
  • 999cfc0 docs/openbsd: fix typos
  • fe549d7 the database is created on-the-fly
  • 2121c99 docs/sealos: fix typos
  • d6e65c9 docs/container: various fixes

📊 Changes

8 files changed (+58 additions, -75 deletions)

View changed files

📝 docs/acls.md (+1 -1)
📝 docs/exit-node.md (+13 -11)
📝 docs/remote-cli.md (+23 -23)
📝 docs/reverse-proxy.md (+3 -3)
📝 docs/running-headscale-container.md (+10 -17)
📝 docs/running-headscale-linux-manual.md (+3 -9)
📝 docs/running-headscale-openbsd.md (+3 -9)
📝 docs/running-headscale-sealos.md (+2 -2)

📄 Description

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.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/juanfont/headscale/pull/2096 **Author:** [@nblock](https://github.com/nblock) **Created:** 9/1/2024 **Status:** ✅ Merged **Merged:** 9/3/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `docs-0.23` --- ### 📝 Commits (9) - [`87b68c5`](https://github.com/juanfont/headscale/commit/87b68c508f66206085b198661b2b5912b98850c6) docs/acl: fix path to policy file - [`0047222`](https://github.com/juanfont/headscale/commit/00472222637e69535f8c3bcd6b66a5f2b00647a9) docs/exit-node: fixup for 0.23 - [`40c7911`](https://github.com/juanfont/headscale/commit/40c791149cb06e4b360f9d420c17cd14f676b88a) docs/remote-cli: fix formatting - [`3f9b95d`](https://github.com/juanfont/headscale/commit/3f9b95d093029f8f4ef0d7a267bf9e883e90d90d) docs/reverse-proxy: remove version information - [`cbc1bd3`](https://github.com/juanfont/headscale/commit/cbc1bd3a6fbd6affbf0936a91d38be759f509bc8) docs/exit-node: add warning to manual documentation - [`999cfc0`](https://github.com/juanfont/headscale/commit/999cfc0de5beb616a8da3ce8f40d90146638a8b8) docs/openbsd: fix typos - [`fe549d7`](https://github.com/juanfont/headscale/commit/fe549d7e2ac1e63e172fa3de8467e68ee3b9f0e5) the database is created on-the-fly - [`2121c99`](https://github.com/juanfont/headscale/commit/2121c99fed9679c31027c991dff23310e08cb887) docs/sealos: fix typos - [`d6e65c9`](https://github.com/juanfont/headscale/commit/d6e65c98da8df75870fd1f8e484721ac868772e3) docs/container: various fixes ### 📊 Changes **8 files changed** (+58 additions, -75 deletions) <details> <summary>View changed files</summary> 📝 `docs/acls.md` (+1 -1) 📝 `docs/exit-node.md` (+13 -11) 📝 `docs/remote-cli.md` (+23 -23) 📝 `docs/reverse-proxy.md` (+3 -3) 📝 `docs/running-headscale-container.md` (+10 -17) 📝 `docs/running-headscale-linux-manual.md` (+3 -9) 📝 `docs/running-headscale-openbsd.md` (+3 -9) 📝 `docs/running-headscale-sealos.md` (+2 -2) </details> ### 📄 Description 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. - [x] have read the [CONTRIBUTING.md](./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 Fixes: #2090 Fixes: #1822 <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## 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. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 03:21:31 +01:00
adam closed this issue 2025-12-29 03:21:31 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2493
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?