mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-23 18:15:26 +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
40 lines
1.7 KiB
Markdown
40 lines
1.7 KiB
Markdown
# Configuration
|
|
|
|
- Headscale loads its configuration from a YAML file
|
|
- It searches for `config.yaml` in the following paths:
|
|
- `/etc/headscale`
|
|
- `$HOME/.headscale`
|
|
- the current working directory
|
|
- Use the command line flag `-c`, `--config` to load the configuration from a different path
|
|
- Validate the configuration file with: `headscale configtest`
|
|
|
|
!!! example "Get the [example configuration from the GitHub repository](https://github.com/juanfont/headscale/blob/main/config-example.yaml)"
|
|
|
|
Always select the [same GitHub tag](https://github.com/juanfont/headscale/tags) as the released version you use to
|
|
ensure you have the correct example configuration. The `main` branch might contain unreleased changes.
|
|
|
|
=== "View on GitHub"
|
|
|
|
* Development version: <https://github.com/juanfont/headscale/blob/main/config-example.yaml>
|
|
* Version {{ headscale.version }}: <https://github.com/juanfont/headscale/blob/v{{ headscale.version }}/config-example.yaml>
|
|
|
|
=== "Download with `wget`"
|
|
|
|
```shell
|
|
# Development version
|
|
wget -O config.yaml https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml
|
|
|
|
# Version {{ headscale.version }}
|
|
wget -O config.yaml https://raw.githubusercontent.com/juanfont/headscale/v{{ headscale.version }}/config-example.yaml
|
|
```
|
|
|
|
=== "Download with `curl`"
|
|
|
|
```shell
|
|
# Development version
|
|
curl -o config.yaml https://raw.githubusercontent.com/juanfont/headscale/main/config-example.yaml
|
|
|
|
# Version {{ headscale.version }}
|
|
curl -o config.yaml https://raw.githubusercontent.com/juanfont/headscale/v{{ headscale.version }}/config-example.yaml
|
|
```
|