[PR #2732] [MERGED] Add DERP documentation #2824

Closed
opened 2025-12-29 04:19:12 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2732
Author: @nblock
Created: 8/15/2025
Status: Merged
Merged: 8/22/2025
Merged by: @nblock

Base: mainHead: derp


📝 Commits (2)

  • 9f45caf Use an IPv4 address range suitable for documentation
  • ea08594 Add DERP docs

📊 Changes

7 files changed (+162 additions, -8 deletions)

View changed files

📝 config-example.yaml (+1 -1)
📝 derp-example.yaml (+3 -3)
📝 docs/about/features.md (+1 -1)
docs/ref/derp.md (+153 -0)
📝 docs/ref/integration/reverse-proxy.md (+1 -1)
📝 docs/setup/requirements.md (+2 -2)
📝 mkdocs.yml (+1 -0)

📄 Description

Document the embedded DERP server along with some typical configuration scenarios.

Preview: https://nblock.github.io/headscale/ref/derp/


  • 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/2732 **Author:** [@nblock](https://github.com/nblock) **Created:** 8/15/2025 **Status:** ✅ Merged **Merged:** 8/22/2025 **Merged by:** [@nblock](https://github.com/nblock) **Base:** `main` ← **Head:** `derp` --- ### 📝 Commits (2) - [`9f45caf`](https://github.com/juanfont/headscale/commit/9f45cafbceda08b43c0453dea2ea5f0c1eec2c19) Use an IPv4 address range suitable for documentation - [`ea08594`](https://github.com/juanfont/headscale/commit/ea085947075fae599533e3afb0e2de3591f83b5b) Add DERP docs ### 📊 Changes **7 files changed** (+162 additions, -8 deletions) <details> <summary>View changed files</summary> 📝 `config-example.yaml` (+1 -1) 📝 `derp-example.yaml` (+3 -3) 📝 `docs/about/features.md` (+1 -1) ➕ `docs/ref/derp.md` (+153 -0) 📝 `docs/ref/integration/reverse-proxy.md` (+1 -1) 📝 `docs/setup/requirements.md` (+2 -2) 📝 `mkdocs.yml` (+1 -0) </details> ### 📄 Description Document the embedded DERP server along with some typical configuration scenarios. Preview: https://nblock.github.io/headscale/ref/derp/ --- - [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 --- <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:12 +01:00
adam closed this issue 2025-12-29 04:19:12 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2824