mirror of
https://github.com/juanfont/headscale.git
synced 2024-12-20 19:09:07 +01: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
29 lines
1.4 KiB
Markdown
29 lines
1.4 KiB
Markdown
# Requirements
|
|
|
|
Headscale should just work as long as the following requirements are met:
|
|
|
|
- A server with a public IP address for headscale. A dual-stack setup with a public IPv4 and a public IPv6 address is
|
|
recommended.
|
|
- Headscale is served via HTTPS on port 443[^1].
|
|
- A reasonably modern Linux or BSD based operating system.
|
|
- A dedicated user account to run headscale.
|
|
- A little bit of command line knowledge to configure and operate headscale.
|
|
|
|
## Assumptions
|
|
|
|
The headscale documentation and the provided examples are written with a few assumptions in mind:
|
|
|
|
- Headscale is running as system service via a dedicated user `headscale`.
|
|
- The [configuration](../ref/configuration.md) is loaded from `/etc/headscale/config.yaml`.
|
|
- SQLite is used as database.
|
|
- The data directory for headscale (used for private keys, ACLs, SQLite database, …) is located in `/var/lib/headscale`.
|
|
- URLs and values that need to be replaced by the user are either denoted as `<VALUE_TO_CHANGE>` or use placeholder
|
|
values such as `headscale.example.com`.
|
|
|
|
Please adjust to your local environment accordingly.
|
|
|
|
[^1]:
|
|
The Tailscale client assumes HTTPS on port 443 in certain situations. Serving headscale either via HTTP or via HTTPS
|
|
on a port other than 443 is possible but sticking with HTTPS on port 443 is strongly recommended for production
|
|
setups. See [issue 2164](https://github.com/juanfont/headscale/issues/2164) for more information.
|