2
0
mirror of https://github.com/pikvm/pikvm synced 2024-11-12 07:10:43 +00:00
pikvm/docs/tailscale.md

70 lines
2.3 KiB
Markdown
Raw Normal View History

2021-10-12 18:45:00 +00:00
# Tailscale VPN
2023-08-18 10:21:12 +00:00
The [Tailscale VPN](https://tailscale.com/) can be used to access PiKVM from the Internet
2023-08-18 04:54:46 +00:00
when using [port forwarding](port_forwarding.md) is not possible or does not seem secure enough.
Tailscale is a convenient and free (for private use) tool for organizing a small VPN network.
2021-10-12 18:45:00 +00:00
2023-08-18 10:21:12 +00:00
Basic Tailscale usage like whats shown below is provided as an example,
2023-08-18 04:54:46 +00:00
any other setting or functionality needs to be redirected to the [Tailscale support](https://tailscale.com/contact/support/).
2023-08-18 10:21:12 +00:00
-----
## Configuring the PiKVM
2021-10-12 18:45:00 +00:00
2023-08-18 10:21:12 +00:00
1. Install the client, run `tailscaled` service and register it in the network:
2021-10-12 18:45:00 +00:00
```
2023-08-18 10:21:12 +00:00
[root@pikvm ~]# rw
[root@pikvm ~]# pacman -Syu
[root@pikvm ~]# pacman -S tailscale-pikvm
[root@pikvm ~]# systemctl enable --now tailscaled
[root@pikvm ~]# tailscale up
2021-10-12 18:45:00 +00:00
```
2. Follow the link to authorize this installation.
2023-08-19 08:47:11 +00:00
3. After success, perform reboot to make sure that everything is working correctly:
2023-08-18 04:54:46 +00:00
2023-08-19 03:55:15 +00:00
```
[root@pikvm ~]# reboot
```
4. Now you can try to view the IP address of Tailscale network interface:
```
[root@pikvm ~]# ip addr show tailscale0
```
2021-10-12 18:45:00 +00:00
2023-08-18 05:04:25 +00:00
If everything is successful, PiKVM will become a member of your VPN network.
2023-08-18 04:54:46 +00:00
!!! warning
2023-08-18 05:04:25 +00:00
**Do not update Tailscale if you don't have access to PiKVM without VPN,
because on breaking change in Tailscale, you may lose access.**
2021-10-12 18:45:00 +00:00
2023-08-18 05:04:25 +00:00
Unfortunately sometimes updating the Tailscale client on PiKVM can cause problems.
This is happening since Tailscale has weak support of read-only systems.
2021-10-12 18:45:00 +00:00
2023-08-18 10:21:12 +00:00
-----
## Configuring a client device
2023-08-18 04:54:46 +00:00
* [Download](https://tailscale.com/download) and install the Tailscale client for your OS
to the system you are using (not to the system you want to control).
2021-10-12 18:45:00 +00:00
* Check the [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 PiKVM web interface.
2023-08-18 04:54:46 +00:00
2023-08-18 10:21:12 +00:00
-----
2023-08-18 04:54:46 +00:00
## Troubleshooting
2023-08-19 03:55:15 +00:00
If something not work, the usual advice is to completely remove the Tailscale from PiKVM and perform a clean installation:
2023-08-18 04:54:46 +00:00
```
2023-08-18 10:21:12 +00:00
[root@pikvm ~]# rw
[root@pikvm ~]# pacman -Rscnd tailscale
[root@pikvm ~]# rm -rf /var/lib/tailscale /var/cache/tailscale
[root@pikvm ~]# reboot
2023-08-18 04:54:46 +00:00
```
2023-08-18 10:21:12 +00:00
Next, follow this page from the beginning to install the Tailscale again.