[PR #2496] [MERGED] Add documentation for routes #2693

Closed
opened 2025-12-29 03:22:23 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2496
Author: @nblock
Created: 3/21/2025
Status: Merged
Merged: 5/3/2025
Merged by: @kradalby

Base: mainHead: routedocs


📝 Commits (3)

  • b85dc5a Add documentation for routes
  • 037701b Update features page for 0.26
  • 0dbef6b Prefer the console lexer when commandline and output mixed

📊 Changes

9 files changed (+310 additions, -62 deletions)

View changed files

📝 CHANGELOG.md (+4 -2)
📝 docs/about/features.md (+10 -7)
📝 docs/ref/dns.md (+2 -2)
docs/ref/exit-node.md (+0 -45)
docs/ref/routes.md (+287 -0)
📝 docs/ref/tls.md (+1 -1)
📝 docs/setup/install/container.md (+2 -2)
📝 hscontrol/policy/v1/acls_types.go (+1 -1)
📝 mkdocs.yml (+3 -2)

📄 Description

  • Rename exit-node to routes and add redirects
  • Add a new section on subnet routers
  • Extend the existing exit-node documentation
  • Describe auto approvers for subnet routers and exit nodes
  • Provide ACL examples for subnet routers and exit nodes
  • Describe HA and its current limitations
  • Add a troubleshooting section with IP forwarding

  • 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

🔄 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/2496 **Author:** [@nblock](https://github.com/nblock) **Created:** 3/21/2025 **Status:** ✅ Merged **Merged:** 5/3/2025 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `routedocs` --- ### 📝 Commits (3) - [`b85dc5a`](https://github.com/juanfont/headscale/commit/b85dc5a3b08c06eaaba54855b216fc07494015a9) Add documentation for routes - [`037701b`](https://github.com/juanfont/headscale/commit/037701b5da496b211f7d70b12b964ca65ce612c1) Update features page for 0.26 - [`0dbef6b`](https://github.com/juanfont/headscale/commit/0dbef6b03d6c0dddb780d622ec8f8194ccba005a) Prefer the console lexer when commandline and output mixed ### 📊 Changes **9 files changed** (+310 additions, -62 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+4 -2) 📝 `docs/about/features.md` (+10 -7) 📝 `docs/ref/dns.md` (+2 -2) ➖ `docs/ref/exit-node.md` (+0 -45) ➕ `docs/ref/routes.md` (+287 -0) 📝 `docs/ref/tls.md` (+1 -1) 📝 `docs/setup/install/container.md` (+2 -2) 📝 `hscontrol/policy/v1/acls_types.go` (+1 -1) 📝 `mkdocs.yml` (+3 -2) </details> ### 📄 Description * Rename exit-node to routes and add redirects * Add a new section on subnet routers * Extend the existing exit-node documentation * Describe auto approvers for subnet routers and exit nodes * Provide ACL examples for subnet routers and exit nodes * Describe HA and its current limitations * Add a troubleshooting section with IP forwarding --- - [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 - [x] updated CHANGELOG.md --- <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:22:23 +01:00
adam closed this issue 2025-12-29 03:22:23 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2693