mirror of
https://github.com/juanfont/headscale.git
synced 2024-12-22 16:07:34 +00:00
8c7d8ee34f
* Setup mkdocs-redirects * Restructure existing documentation * Move client OS support into the documentation * Move existing Client OS support table into its own documentation page * Link from README.md to the rendered documentation * Document minimum Tailscale client version * Reuse CONTRIBUTING.md" in the documentation * Include "CONTRIBUTING.md" from the repository root * Update FAQ and index page and link to the contributing docs * Add configuration reference * Add a getting started page and explain the first steps with headscale * Use the existing "Using headscale" sections and combine them into a single getting started guide with a little bit more explanation. * Explain how to get help from the command line client. * Remove duplicated sections from existing installation guides * Document requirements and assumptions * Document packages provided by the community * Move deb install guide to official releases * Move manual install guide to official releases * Move container documentation to setup section * Move sealos documentation to cloud install page * Move OpenBSD docs to build from source * Simplify DNS documentation * Add sponsor page * Add releases page * Add features page * Add help page * Add upgrading page * Adjust mkdocs nav * Update wording Use the term headscale for the project, Headscale on the beginning of a sentence and `headscale` when refering to the CLI. * Welcome to headscale * Link to existing documentation in the FAQ * Remove the goal header and use the text as opener * Indent code block in OIDC * Make a few pages linter compatible Also update ignored files for prettier * Recommend HTTPS on port 443 Fixes: #2164 * Use hosts in acl documentation thx @efficacy38 for noticing this Ref: #1863 * Use mkdocs-macros to set headscale version once
55 lines
3.0 KiB
Markdown
55 lines
3.0 KiB
Markdown
# Frequently Asked Questions
|
|
|
|
## What is the design goal of headscale?
|
|
|
|
Headscale aims to implement a self-hosted, open source alternative to the [Tailscale](https://tailscale.com/)
|
|
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.
|
|
|
|
## How can I contribute?
|
|
|
|
Headscale is "Open Source, acknowledged contribution", this means that any
|
|
contribution will have to be discussed with the Maintainers before being submitted.
|
|
|
|
Please see [Contributing](contributing.md) for more information.
|
|
|
|
## Why is 'acknowledged contribution' the chosen model?
|
|
|
|
Both maintainers have full-time jobs and families, and we want to avoid burnout. We also want to avoid frustration from contributors when their PRs are not accepted.
|
|
|
|
We are more than happy to exchange emails, or to have dedicated calls before a PR is submitted.
|
|
|
|
## When/Why is Feature X going to be implemented?
|
|
|
|
We don't know. We might be working on it. If you're interested in contributing, please post a feature request about it.
|
|
|
|
Please be aware that there are a number of reasons why we might not accept specific contributions:
|
|
|
|
- It is not possible to implement the feature in a way that makes sense in a self-hosted environment.
|
|
- Given that we are reverse-engineering Tailscale to satisfy our own curiosity, we might be interested in implementing the feature ourselves.
|
|
- You are not sending unit and integration tests with it.
|
|
|
|
## Do you support Y method of deploying headscale?
|
|
|
|
We currently support deploying headscale using our binaries and the DEB packages. Visit our [installation guide using
|
|
official releases](../setup/install/official.md) for more information.
|
|
|
|
In addition to that, you may use packages provided by the community or from distributions. Learn more in the
|
|
[installation guide using community packages](../setup/install/community.md).
|
|
|
|
For convenience, we also [build Docker images with headscale](../setup/install/container.md). But **please be aware that
|
|
we don't officially support deploying headscale using Docker**. We have a [Discord
|
|
channel](https://discord.com/channels/896711691637780480/1070619770942148618) where you can ask for Docker-specific help
|
|
to the community.
|
|
|
|
## Why is my reverse proxy not working with headscale?
|
|
|
|
We don't know. We don't use reverse proxies with headscale ourselves, so we don't have any experience with them. We have [community documentation](../ref/integration/reverse-proxy.md) on how to configure various reverse proxies, and a dedicated [Discord channel](https://discord.com/channels/896711691637780480/1070619818346164324) where you can ask for help to the community.
|
|
|
|
## Can I use headscale and tailscale on the same machine?
|
|
|
|
Running headscale on a machine that is also in the tailnet can cause problems with subnet routers, traffic relay nodes, and MagicDNS. It might work, but it is not supported.
|