Connecting an Apple client

This documentation has the goal of showing how a user can use the official iOS and macOS Tailscale clients with headscale.

!!! info "Instructions on your headscale instance"

An endpoint with information on how to connect your Apple device
is also available at `/apple` on your running instance.

iOS

Install the official Tailscale iOS client from the App Store.

Open Tailscale and make sure you are not logged in to any account
Open Settings on the iOS device
Scroll down to the third party apps section, under Game Center or TV Provider
Find Tailscale and select it
- If the iOS device was previously logged into Tailscale, switch the Reset Keychain toggle to on
Enter the URL of your headscale instance (e.g https://headscale.example.com) under Alternate Coordination Server URL
Restart the app by closing it from the iOS app switcher, open the app and select the regular sign in option (non-SSO). It should open up to the headscale authentication page.
Enter your credentials and log in. Headscale should now be working on your iOS device.

Choose one of the available Tailscale clients for macOS and install it.

Use Tailscale's login command to connect with your headscale instance (e.g https://headscale.example.com):

tailscale login --login-server <YOUR_HEADSCALE_URL>

ALT + Click the Tailscale icon in the menu and hover over the Debug menu
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

Install the official Tailscale tvOS client from the App Store.

Caution

DON't open the Tailscale App after installation!.

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