mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-25 02:55:29 +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
52 lines
1.5 KiB
Markdown
52 lines
1.5 KiB
Markdown
# Exit Nodes
|
|
|
|
## On the node
|
|
|
|
Register the node and make it advertise itself as an exit node:
|
|
|
|
```console
|
|
$ sudo tailscale up --login-server https://headscale.example.com --advertise-exit-node
|
|
```
|
|
|
|
If the node is already registered, it can advertise exit capabilities like this:
|
|
|
|
```console
|
|
$ sudo tailscale set --advertise-exit-node
|
|
```
|
|
|
|
To use a node as an exit node, IP forwarding must be enabled on the node. Check the official [Tailscale documentation](https://tailscale.com/kb/1019/subnets/?tab=linux#enable-ip-forwarding) for how to enable IP forwarding.
|
|
|
|
## On the control server
|
|
|
|
```console
|
|
$ # list nodes
|
|
$ headscale routes list
|
|
ID | Node | Prefix | Advertised | Enabled | Primary
|
|
1 | | 0.0.0.0/0 | false | false | -
|
|
2 | | ::/0 | false | false | -
|
|
3 | phobos | 0.0.0.0/0 | true | false | -
|
|
4 | phobos | ::/0 | true | false | -
|
|
|
|
$ # enable routes for phobos
|
|
$ headscale routes enable -r 3
|
|
$ headscale routes enable -r 4
|
|
|
|
$ # Check node list again. The routes are now enabled.
|
|
$ headscale routes list
|
|
ID | Node | Prefix | Advertised | Enabled | Primary
|
|
1 | | 0.0.0.0/0 | false | false | -
|
|
2 | | ::/0 | false | false | -
|
|
3 | phobos | 0.0.0.0/0 | true | true | -
|
|
4 | phobos | ::/0 | true | true | -
|
|
```
|
|
|
|
## On the client
|
|
|
|
The exit node can now be used with:
|
|
|
|
```console
|
|
$ sudo tailscale set --exit-node phobos
|
|
```
|
|
|
|
Check the official [Tailscale documentation](https://tailscale.com/kb/1103/exit-nodes#use-the-exit-node) for how to do it on your device.
|