From ba45d7dbd3a7e9bed568a9b6faef8891b2d2280e Mon Sep 17 00:00:00 2001 From: Kristoffer Dalby Date: Wed, 10 May 2023 09:03:13 +0200 Subject: [PATCH] update readme and templates to clarify scope (#1437) Co-authored-by: Juan Font --- .github/ISSUE_TEMPLATE/bug_report.md | 36 ++++++++++++++++++----- .github/ISSUE_TEMPLATE/feature_request.md | 17 ++++++++--- .github/ISSUE_TEMPLATE/other_issue.md | 30 ------------------- .github/pull_request_template.md | 12 ++++++++ .github/renovate.json | 26 +++++++--------- README.md | 36 +++++++++++++++-------- 6 files changed, 88 insertions(+), 69 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/other_issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d989a84..02e4742 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -6,19 +6,24 @@ labels: ["bug"] assignees: "" --- - + + +## Bug description -**To Reproduce** - - - -**Context info** +## Environment + +- OS: +- Headscale version: +- Tailscale version: + + + +- [ ] Headscale is behind a (reverse) proxy +- [ ] Headscale runs in a container + +## To Reproduce + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index a9428c0..92c51b8 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -6,12 +6,21 @@ labels: ["enhancement"] assignees: "" --- - + - +## Why - + +## Description + + diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md deleted file mode 100644 index 3004a97..0000000 --- a/.github/ISSUE_TEMPLATE/other_issue.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: "Other issue" -about: "Report a different issue" -title: "" -labels: ["bug"] -assignees: "" ---- - - - - - -**Issue description** - - - -**To Reproduce** - - - -**Context info** - - diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 88289da..d4e4f4f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,3 +1,15 @@ + + - [ ] read the [CONTRIBUTING guidelines](README.md#contributing) diff --git a/.github/renovate.json b/.github/renovate.json index ce38ba9..7b3ef57 100644 --- a/.github/renovate.json +++ b/.github/renovate.json @@ -6,31 +6,27 @@ "onboarding": false, "extends": ["config:base", ":rebaseStalePrs"], "ignorePresets": [":prHourlyLimit2"], - "enabledManagers": ["dockerfile", "gomod", "github-actions","regex" ], + "enabledManagers": ["dockerfile", "gomod", "github-actions", "regex"], "includeForks": true, "repositories": ["juanfont/headscale"], "platform": "github", "packageRules": [ { - "matchDatasources": ["go"], - "groupName": "Go modules", - "groupSlug": "gomod", - "separateMajorMinor": false + "matchDatasources": ["go"], + "groupName": "Go modules", + "groupSlug": "gomod", + "separateMajorMinor": false }, { - "matchDatasources": ["docker"], - "groupName": "Dockerfiles", - "groupSlug": "dockerfiles" - } + "matchDatasources": ["docker"], + "groupName": "Dockerfiles", + "groupSlug": "dockerfiles" + } ], "regexManagers": [ { - "fileMatch": [ - ".github/workflows/.*.yml$" - ], - "matchStrings": [ - "\\s*go-version:\\s*\"?(?.*?)\"?\\n" - ], + "fileMatch": [".github/workflows/.*.yml$"], + "matchStrings": ["\\s*go-version:\\s*\"?(?.*?)\"?\\n"], "datasourceTemplate": "golang-version", "depNameTemplate": "actions/go-version" } diff --git a/README.md b/README.md index ac72a9d..519ec23 100644 --- a/README.md +++ b/README.md @@ -32,21 +32,18 @@ organisation. ## Design goal -`headscale` aims to implement a self-hosted, open source alternative to the Tailscale -control server. `headscale` has a narrower scope and an instance of `headscale` -implements a _single_ Tailnet, which is typically what a single organisation, or -home/personal setup would use. +Headscale aims to implement a self-hosted, open source alternative to the Tailscale +control server. +Headscale's goal is to provide self-hosters and hobbyists with an open-source +server they can use for their projects and labs. +It implements a narrow scope, a single Tailnet, suitable for a personal use, or a small +open-source organisation. -`headscale` uses terms that maps to Tailscale's control server, consult the - -## Support +## Supporting Headscale If you like `headscale` and find it useful, there is a sponsorship and donation buttons available in the repo. -If you would like to sponsor features, bugs or prioritisation, reach out to -one of the maintainers. - ## Features - Full "base" support of Tailscale's features @@ -78,6 +75,9 @@ one of the maintainers. ## Running headscale +**Please note that we do not support nor encourage the use of reverse proxies +and container to run Headscale.** + Please have a look at the [`documentation`](https://headscale.net/). ## Graphical Control Panels @@ -96,11 +96,23 @@ These are community projects not directly affiliated with the Headscale project. ## Disclaimer -1. We have nothing to do with Tailscale, or Tailscale Inc. +1. This project is not associated with Tailscale Inc. 2. The purpose of Headscale is maintaining a working, self-hosted Tailscale control panel. ## Contributing +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. + +### Requirements + To contribute to headscale you would need the lastest version of [Go](https://golang.org) and [Buf](https://buf.build)(Protobuf generator). @@ -108,8 +120,6 @@ We recommend using [Nix](https://nixos.org/) to setup a development environment. be done with `nix develop`, which will install the tools and give you a shell. This guarantees that you will have the same dev env as `headscale` maintainers. -PRs and suggestions are welcome. - ### Code style To ensure we have some consistency with a growing number of contributions,