Skip to content

Commit 18d21d3

Browse files
authored
Add documentation for routes (#2496)
* Add documentation for routes * Rename exit-node to routes and add redirects * Add a new section on subnet routers * Extend the existing exit-node documentation * Describe auto approvers for subnet routers and exit nodes * Provide ACL examples for subnet routers and exit nodes * Describe HA and its current limitations * Add a troubleshooting section with IP forwarding * Update features page for 0.26 Add auto approvers and link to our documentation if available. * Prefer the console lexer when commandline and output mixed
1 parent e7d2d79 commit 18d21d3

File tree

9 files changed

+310
-62
lines changed

9 files changed

+310
-62
lines changed

CHANGELOG.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ this, the CLI and API has been simplified to reflect the changes;
1616

1717
```console
1818
$ headscale nodes list-routes
19-
ID | Hostname | Approved | Available | Serving
19+
ID | Hostname | Approved | Available | Serving (Primary)
2020
1 | ts-head-ruqsg8 | | 0.0.0.0/0, ::/0 |
2121
2 | ts-unstable-fq7ob4 | | 0.0.0.0/0, ::/0 |
2222

2323
$ headscale nodes approve-routes --identifier 1 --routes 0.0.0.0/0,::/0
2424
Node updated
2525

2626
$ headscale nodes list-routes
27-
ID | Hostname | Approved | Available | Serving
27+
ID | Hostname | Approved | Available | Serving (Primary)
2828
1 | ts-head-ruqsg8 | 0.0.0.0/0, ::/0 | 0.0.0.0/0, ::/0 | 0.0.0.0/0, ::/0
2929
2 | ts-unstable-fq7ob4 | | 0.0.0.0/0, ::/0 |
3030
```
@@ -106,6 +106,8 @@ working in v1 and not tested might be broken in v2 (and vice versa).
106106
[#2503](https://github.com/juanfont/headscale/pull/2503)
107107
- Restore support for "Override local DNS"
108108
[#2438](https://github.com/juanfont/headscale/pull/2438)
109+
- Add documentation for routes
110+
[#2496](https://github.com/juanfont/headscale/pull/2496)
109111

110112
## 0.25.1 (2025-02-25)
111113

docs/about/features.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,30 @@
22

33
Headscale aims to implement a self-hosted, open source alternative to the Tailscale control server. Headscale's goal is
44
to provide self-hosters and hobbyists with an open-source server they can use for their projects and labs. This page
5-
provides on overview of headscale's feature and compatibility with the Tailscale control server:
5+
provides on overview of Headscale's feature and compatibility with the Tailscale control server:
66

77
- [x] Full "base" support of Tailscale's features
88
- [x] Node registration
99
- [x] Interactive
1010
- [x] Pre authenticated key
11-
- [x] [DNS](https://tailscale.com/kb/1054/dns)
11+
- [x] [DNS](../ref/dns.md)
1212
- [x] [MagicDNS](https://tailscale.com/kb/1081/magicdns)
1313
- [x] [Global and restricted nameservers (split DNS)](https://tailscale.com/kb/1054/dns#nameservers)
1414
- [x] [search domains](https://tailscale.com/kb/1054/dns#search-domains)
15-
- [x] [Extra DNS records (headscale only)](../ref/dns.md#setting-extra-dns-records)
15+
- [x] [Extra DNS records (Headscale only)](../ref/dns.md#setting-extra-dns-records)
1616
- [x] [Taildrop (File Sharing)](https://tailscale.com/kb/1106/taildrop)
17-
- [x] Routing advertising (including exit nodes)
17+
- [x] [Routes](../ref/routes.md)
18+
- [x] [Subnet routers](../ref/routes.md#subnet-router)
19+
- [x] [Exit nodes](../ref/routes.md#exit-node)
1820
- [x] Dual stack (IPv4 and IPv6)
1921
- [x] Ephemeral nodes
2022
- [x] Embedded [DERP server](https://tailscale.com/kb/1232/derp-servers)
2123
- [x] Access control lists ([GitHub label "policy"](https://github.com/juanfont/headscale/labels/policy%20%F0%9F%93%9D))
2224
- [x] ACL management via API
23-
- [x] `autogroup:internet`
24-
- [ ] `autogroup:self`
25-
- [ ] `autogroup:member`
25+
- [x] Some [Autogroups](https://tailscale.com/kb/1396/targets#autogroups), currently: `autogroup:internet`
26+
- [x] [Auto approvers](https://tailscale.com/kb/1337/acl-syntax#auto-approvers) for [subnet
27+
routers](../ref/routes.md#automatically-approve-routes-of-a-subnet-router) and [exit
28+
nodes](../ref/routes.md#automatically-approve-an-exit-node-with-auto-approvers)
2629
* [ ] Node registration using Single-Sign-On (OpenID Connect) ([GitHub label "OIDC"](https://github.com/juanfont/headscale/labels/OIDC))
2730
- [x] Basic registration
2831
- [x] Update user profile from identity provider

docs/ref/dns.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,14 +76,14 @@ hostname and port combination "http://hostname-in-magic-dns.myvpn.example.com:30
7676

7777
=== "Query with dig"
7878

79-
```shell
79+
```console
8080
dig +short grafana.myvpn.example.com
8181
100.64.0.3
8282
```
8383

8484
=== "Query with drill"
8585

86-
```shell
86+
```console
8787
drill -Q grafana.myvpn.example.com
8888
100.64.0.3
8989
```

docs/ref/exit-node.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

0 commit comments

Comments
 (0)