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

[PR #2975] Documentation updates for 0.28.0 #2974

New Issue
Open
opened 2025-12-29 04:19:53 +01:00 by adam · 0 comments
adam commented 2025-12-29 04:19:53 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2975
Author: @nblock
Created: 12/19/2025
Status: 🔄 Open

Base: main ← Head: docs-0.28

📝 Commits (8)

  • c12136a Document how to disable the metrics interfaces
  • 76bc867 Document /version in the API docs
  • 2557950 Changelog: mark oidc.email_verified_required as breaking
  • 97c7d39 Document oidc.email_verification_required
  • b07e083 Fix list-routes examples
  • 04bb4a3 Bump version in mkdocs
  • 76dc2c7 Fix ownership description for auto approved routers/exits
  • ef9058c Mention tags on the features page

📊 Changes

8 files changed (+55 additions, -20 deletions)

View changed files

📝 CHANGELOG.md (+6 -3)
📝 config-example.yaml (+7 -0)
📝 docs/about/features.md (+1 -0)
📝 docs/ref/api.md (+1 -0)
📝 docs/ref/debug.md (+3 -0)
📝 docs/ref/oidc.md (+20 -3)
📝 docs/ref/routes.md (+16 -13)
📝 mkdocs.yml (+1 -1)

📄 Description

  • Document /version
  • Disable metrics interface
  • Fix tags related docs for subnet routers and exit nodes
  • Fix headscale nodes list-routes output
  • oidc.email_verified_required and how to control email verification requirements

Please see commit messages for details.

  • 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/2975 **Author:** [@nblock](https://github.com/nblock) **Created:** 12/19/2025 **Status:** 🔄 Open **Base:** `main` ← **Head:** `docs-0.28` --- ### 📝 Commits (8) - [`c12136a`](https://github.com/juanfont/headscale/commit/c12136a0a7985c0d7f2cea7ac3b3bca503fcd05e) Document how to disable the metrics interfaces - [`76bc867`](https://github.com/juanfont/headscale/commit/76bc86740bb0c4ef8ab26166fd95549260662edb) Document /version in the API docs - [`2557950`](https://github.com/juanfont/headscale/commit/2557950a4897bb4b48ee51361edabb37cede5a09) Changelog: mark oidc.email_verified_required as breaking - [`97c7d39`](https://github.com/juanfont/headscale/commit/97c7d3903a6da6852eb8ca89a5dc9ad9b343c2d0) Document oidc.email_verification_required - [`b07e083`](https://github.com/juanfont/headscale/commit/b07e083ec1d509f0c7d59a4da0cba0427d78a33e) Fix list-routes examples - [`04bb4a3`](https://github.com/juanfont/headscale/commit/04bb4a3d23404cdfbc218ba95674df9d06a5fd73) Bump version in mkdocs - [`76dc2c7`](https://github.com/juanfont/headscale/commit/76dc2c7de42637c6012ef1c00fd577fb08519f04) Fix ownership description for auto approved routers/exits - [`ef9058c`](https://github.com/juanfont/headscale/commit/ef9058c673d097ad36c740e515ab00db6d4558f9) Mention tags on the features page ### 📊 Changes **8 files changed** (+55 additions, -20 deletions) <details> <summary>View changed files</summary> 📝 `CHANGELOG.md` (+6 -3) 📝 `config-example.yaml` (+7 -0) 📝 `docs/about/features.md` (+1 -0) 📝 `docs/ref/api.md` (+1 -0) 📝 `docs/ref/debug.md` (+3 -0) 📝 `docs/ref/oidc.md` (+20 -3) 📝 `docs/ref/routes.md` (+16 -13) 📝 `mkdocs.yml` (+1 -1) </details> ### 📄 Description - [x] Document `/version` - [x] Disable metrics interface - [x] Fix tags related docs for subnet routers and exit nodes - [x] Fix `headscale nodes list-routes` output - [x] `oidc.email_verified_required` and how to control email verification requirements Please see commit messages for details. --- <!-- Please tick if the following things apply. You… --> - [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 <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> --- <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 04:19:53 +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#2974
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?