[PR #197] [MERGED] Unify configuration, comment the options in config #1316

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

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/197
Author: @kradalby
Created: 10/22/2021
Status: Merged
Merged: 10/24/2021
Merged by: @kradalby

Base: mainHead: config-simplification


📝 Commits (6)

  • b85adbc Remove the need for multiple config files
  • 4d4d0de Start adding comments to config
  • 8853315 Update config-example.yaml
  • 7da3d4b Resolve merge conflict
  • 1237e02 Merge branch 'config-simplification' of github.com:kradalby/headscale into config-simplification
  • 746d403 Fix config and tests

📊 Changes

3 files changed (+32 additions, -70 deletions)

View changed files

📝 cmd/headscale/headscale_test.go (+3 -35)
📝 config-example.yaml (+29 -6)
config.yaml.postgres.example (+0 -29)

📄 Description

This PR removes the second configuration file so the users only have one place to look and we only have one place to update.

I have also started to add comments to the configuration file describing the configuration options available, and hopefully that can be the start of using it as the main documentation so we only have to update one thing.

I would appreciate if people would help me a bit by using GitHub Comments "suggestions" to add documentation strings to the options that are missing them (or improve my suggestions).


🔄 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/197 **Author:** [@kradalby](https://github.com/kradalby) **Created:** 10/22/2021 **Status:** ✅ Merged **Merged:** 10/24/2021 **Merged by:** [@kradalby](https://github.com/kradalby) **Base:** `main` ← **Head:** `config-simplification` --- ### 📝 Commits (6) - [`b85adbc`](https://github.com/juanfont/headscale/commit/b85adbc40a5119b202f2312e0ac8dd2a3e1a3716) Remove the need for multiple config files - [`4d4d0de`](https://github.com/juanfont/headscale/commit/4d4d0de356d47f1e19c22b92d0ae0b8ef2fcc196) Start adding comments to config - [`8853315`](https://github.com/juanfont/headscale/commit/8853315dcca2b8e7c43a14fec4f7a50e6ed61d89) Update config-example.yaml - [`7da3d4b`](https://github.com/juanfont/headscale/commit/7da3d4ba50bdf366a6e3e01a4c129fbd8c0323f8) Resolve merge conflict - [`1237e02`](https://github.com/juanfont/headscale/commit/1237e02f7c0ad4dfc111228db9bf7402ffc373b4) Merge branch 'config-simplification' of github.com:kradalby/headscale into config-simplification - [`746d403`](https://github.com/juanfont/headscale/commit/746d4037da46ff1e6682b6d8a79579f7dfb87c94) Fix config and tests ### 📊 Changes **3 files changed** (+32 additions, -70 deletions) <details> <summary>View changed files</summary> 📝 `cmd/headscale/headscale_test.go` (+3 -35) 📝 `config-example.yaml` (+29 -6) ➖ `config.yaml.postgres.example` (+0 -29) </details> ### 📄 Description This PR removes the second configuration file so the users only have one place to look and we only have one place to update. I have also started to add comments to the configuration file describing the configuration options available, and hopefully that can be the start of using it as the main documentation so we only have to update one thing. I would appreciate if people would help me a bit by using GitHub Comments "suggestions" to add documentation strings to the options that are missing them (or improve my suggestions). --- <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 02:29:40 +01:00
adam closed this issue 2025-12-29 02:29:40 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#1316