Improving documentation for DNS config

This commit is contained in:
Juan Font Alonso 2021-10-02 11:11:18 +02:00
parent 3f3cfedffa
commit c9e4da3ff5
3 changed files with 41 additions and 2 deletions

View file

@ -20,6 +20,9 @@
"dns_config": {
"nameservers": [
"1.1.1.1"
]
],
"domains": [],
"magic_dns": true,
"base_domain": "example.com"
}
}

View file

@ -16,6 +16,9 @@
"dns_config": {
"nameservers": [
"1.1.1.1"
]
],
"domains": [],
"magic_dns": true,
"base_domain": "example.com"
}
}

33
docs/DNS.md Normal file
View file

@ -0,0 +1,33 @@
# DNS in Headscale
Headscale supports Tailscale's DNS configuration and MagicDNS. Please have a look to their KB to better understand what this means:
- https://tailscale.com/kb/1054/dns/
- https://tailscale.com/kb/1081/magicdns/
- https://tailscale.com/blog/2021-09-private-dns-with-magicdns/
Long story short, you can define the DNS servers you want to use in your tailnets, activate MagicDNS (so you don't have to remember the IP addresses of your nodes), define search domains, as well as predefined hosts. Headscale will inject that settings into your nodes.
## Configuration reference
The setup is done via the `config.json` file, under the `dns_config` key.
```json
{
"server_url": "http://127.0.0.1:8001",
"listen_addr": "0.0.0.0:8001",
"private_key_path": "private.key",
//...
"dns_config": {
"nameservers": ["1.1.1.1", "8.8.8.8"],
"domains": [],
"magic_dns": true,
"base_domain": "example.com"
}
}
```
- `nameservers`: The list of DNS servers to use.
- `domains`: Search domains to inject.
- `magic_dns`: Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/).
- `base_domain`: Defines the base domain to create the hostnames for MagicDNS. `base_domain` must be a FQDNs, without the trailing dot. The FQDN of the hosts will be `hostname.namespace.base_domain` (e.g., _myhost.mynamespace.example.com_).