From b4e867d4729ddc98c57e9be0d9d8ab87b74da5cd Mon Sep 17 00:00:00 2001 From: Philip Henning Date: Mon, 4 Nov 2024 23:11:15 +0100 Subject: [PATCH] Add usage documentation for tvOS --- docs/about/clients.md | 1 + docs/usage/connect/apple.md | 20 ++++++++++++++++++++ hscontrol/templates/apple.go | 34 ++++++++++++++++++++++++++++++++++ 3 files changed, 55 insertions(+) diff --git a/docs/about/clients.md b/docs/about/clients.md index eafb2946..cb8e4b6d 100644 --- a/docs/about/clients.md +++ b/docs/about/clients.md @@ -13,3 +13,4 @@ headscale. | Android | Yes (see [docs](../usage/connect/android.md)) | | macOS | Yes (see [docs](../usage/connect/apple.md#macos) and `/apple` on your headscale for more information) | | iOS | Yes (see [docs](../usage/connect/apple.md#ios) and `/apple` on your headscale for more information) | +| tvOS | Yes (see [docs](../usage/connect/apple.md#tvos) and `/apple` on your headscale for more information) | diff --git a/docs/usage/connect/apple.md b/docs/usage/connect/apple.md index 7597c717..d9aa8436 100644 --- a/docs/usage/connect/apple.md +++ b/docs/usage/connect/apple.md @@ -47,3 +47,23 @@ tailscale login --login-server - Under `Custom Login Server`, select `Add Account...` - Enter the URL of your headscale instance (e.g `https://headscale.example.com`) and press `Add Account` - Follow the login procedure in the browser + +## tvOS + +### Installation + +Install the official Tailscale tvOS client from the [App Store](https://apps.apple.com/app/tailscale/id1470499037). + +> [!CAUTION] +> __DON't__ open the Tailscale App after installation!. + +### Configuring the headscale URL + +- Go Settings (the apple tvOS settings) > Apps > Tailscale +- Under `ALTERNATE COORDINATION SERVER URL`, select `URL` +- Enter the URL of your headscale instance (e.g `https://headscale.example.com`) and press `OK` +- Return to the tvOS Home screen +- Open Tailscale +- `Install VPN configuration` +- `Allow` +- Scan the QR code and follow the login procedure diff --git a/hscontrol/templates/apple.go b/hscontrol/templates/apple.go index 93f0034d..f6a7c61a 100644 --- a/hscontrol/templates/apple.go +++ b/hscontrol/templates/apple.go @@ -144,6 +144,40 @@ func Apple(url string) *elem.Element { ), ), ), + headerOne("headscale: tvOS configuration"), + headerTwo("GUI"), + elem.Ol(nil, + elem.Li(nil, + elem.Text("Install the official Tailscale iOS client from the "), + elem.A(attrs.Props{attrs.Href: "https://apps.apple.com/app/tailscale/id1470499037"}, + elem.Text("App store"), + ), + ), + elem.Li(nil, + elem.Text("Go Settings (the apple tvOS settings) > Apps > Tailscale") + ), + elem.Li(nil, + elem.Text(fmt.Sprintf(`Enter "%s" under "ALTERNATE COORDINATION SERVER URL"`,url)), + ), + elem.Li(nil, + elem.Text("Return to the tvOS Home screen") + ), + elem.Li(nil, + elem.Text("Open Tailscale") + ), + elem.Li(nil, + elem.Text("Select \"Install VPN configuration\"") + ), + elem.Li(nil, + elem.Text("Select \"Allow\"") + ), + elem.Li(nil, + elem.Text("Scan the QR code and follow the login procedure") + ), + elem.Li(nil, + elem.Text("Headscale should now be working on your tvOS device"), + ), + ), ), ) }