mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-29 18:33:05 +00:00
document running exit nodes
Currently the only kind-of documentation is #210 which is outdated. To remedy this, add a document describing the process.
This commit is contained in:
parent
003036a779
commit
d12f247490
1 changed files with 47 additions and 0 deletions
47
docs/exit-node.md
Normal file
47
docs/exit-node.md
Normal file
|
@ -0,0 +1,47 @@
|
||||||
|
# Exit Nodes
|
||||||
|
|
||||||
|
## On the node
|
||||||
|
|
||||||
|
Register the node and make it advertise itself as an exit node:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ sudo tailscale up --login-server https://my-server.com --advertise-exit-node
|
||||||
|
```
|
||||||
|
|
||||||
|
If the node is already registered, it can advertise exit capabilities like this:
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ sudo tailscale set --advertise-exit-node
|
||||||
|
```
|
||||||
|
|
||||||
|
## On the control server
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ # list nodes
|
||||||
|
$ headscale routes list
|
||||||
|
ID | Machine | 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 | Machine | 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/?q=exit#step-3-use-the-exit-node) for how to do it on your device.
|
Loading…
Reference in a new issue