[PR #1733] [MERGED] TLS documentation updates #2281

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/1733
Author: @lgrn
Created: 2/10/2024
Status: Merged
Merged: 2/15/2024
Merged by: @kradalby

Base: mainHead: main


📝 Commits (2)

📊 Changes

1 file changed (+55 additions, -10 deletions)

View changed files

📝 docs/tls.md (+55 -10)

📄 Description

Move "Bring your own certificates" to the top
since the letsencrypt section is now much longer, it seems wrong to
keep such a short section way down at the bottom.

Restructure "Challenge types" into separate sections

Add technical description of letsencrypt renewals
this aims to answer:

  • what can be expected in terms of renewals
  • what logs can be expected (none)
  • how to validate that renewal happened successfully
  • the reason for some of the 'acme/autocert' logs, or at least some best-effort assumptions
  • read the CONTRIBUTING guidelines
  • 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/1733 **Author:** [@lgrn](https://github.com/lgrn) **Created:** 2/10/2024 **Status:** ✅ Merged **Merged:** 2/15/2024 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `main` --- ### 📝 Commits (2) - [`44b4947`](https://github.com/juanfont/headscale/commit/44b494756898e6755db2e23f4a84550922389301) TLS documentation updates - [`b034d08`](https://github.com/juanfont/headscale/commit/b034d088850ed54339cf2f94d7ec954063022a05) +prettier ### 📊 Changes **1 file changed** (+55 additions, -10 deletions) <details> <summary>View changed files</summary> 📝 `docs/tls.md` (+55 -10) </details> ### 📄 Description Move "Bring your own certificates" to the top since the letsencrypt section is now much longer, it seems wrong to keep such a short section way down at the bottom. Restructure "Challenge types" into separate sections Add technical description of letsencrypt renewals this aims to answer: - what can be expected in terms of renewals - what logs can be expected (none) - how to validate that renewal happened successfully - the reason for some of the 'acme/autocert' logs, or at least some best-effort assumptions <!-- Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted. This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code. Headscale is open to code contributions for bug fixes without discussion. If you find mistakes in the documentation, please submit a fix to the documentation. --> <!-- Please tick if the following things apply. You… --> - [x] read the [CONTRIBUTING guidelines](README.md#contributing) - [x] 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 <!-- 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 03:20:32 +01:00
adam closed this issue 2025-12-29 03:20:32 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2281