You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pikvm/docs/tailscale.md

72 lines
2.3 KiB
Markdown

3 years ago
# Tailscale VPN
10 months ago
The [Tailscale VPN](https://tailscale.com/) can be used to access PiKVM from the Internet
10 months ago
if configuring [port forwarding](port_forwarding.md) is not possible or more security is desired.
10 months ago
Tailscale is a convenient and free (for private use) tool for organizing a small VPN network.
3 years ago
10 months ago
The basic Tailscale configuration commands are shown below.
For detailed instructions, refer to [Tailscale support](https://tailscale.com/contact/support/).
10 months ago
10 months ago
-----
## Configuring the PiKVM
3 years ago
4 months ago
1. Update OS:
{!_update_os.md!}
2. Install the Tailscale client, run `tailscaled` service and register it in the network:
3 years ago
10 months ago
```console
10 months ago
[root@pikvm ~]# rw
[root@pikvm ~]# pacman -S tailscale-pikvm
[root@pikvm ~]# systemctl enable --now tailscaled
[root@pikvm ~]# tailscale up
3 years ago
```
4 months ago
3. Follow the link to authorize this installation.
10 months ago
You likely want to [disable key expiry](https://tailscale.com/kb/1028/key-expiry/)!
3 years ago
4 months ago
4. After authorization success, reboot to make sure that everything works correctly:
10 months ago
10 months ago
```console
10 months ago
[root@pikvm ~]# reboot
```
4 months ago
5. Now, you can view the IP address of the Tailscale network interface:
10 months ago
10 months ago
```console
10 months ago
[root@pikvm ~]# ip addr show tailscale0
```
3 years ago
10 months ago
If everything is successful, PiKVM will become a member of your VPN network.
10 months ago
!!! warning "Do not update Tailscale if you don't have access to PiKVM without VPN"
10 months ago
Unfortunately, sometimes, updating the Tailscale client can cause problems due to breaking changes.
10 months ago
These are compatibility issues on the Tailscale side.
10 months ago
Remember this when updating.
3 years ago
10 months ago
-----
## Configuring a client device
10 months ago
10 months ago
* [Download](https://tailscale.com/download) and install the Tailscale client
10 months ago
to the system you are using (not to the system you want to control).
10 months ago
* Check the [Tailscale admin page](https://login.tailscale.com/admin/machines) to view your VPN network.
* Follow the URL in the web browser: `https://<tailscale_kvm_ip>` and you will see the PiKVM web interface.
10 months ago
10 months ago
-----
10 months ago
## Troubleshooting
10 months ago
If something does not work, the usual advice is to completely remove Tailscale from PiKVM and perform a clean installation:
10 months ago
10 months ago
```console
10 months ago
[root@pikvm ~]# rw
[root@pikvm ~]# pacman -Rscnd tailscale
[root@pikvm ~]# rm -rf /var/lib/tailscale /var/cache/tailscale
[root@pikvm ~]# reboot
10 months ago
```
10 months ago
Now, follow the instructions from the beginning to re-install Tailscale.