devproje/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2024-11-27 09:23:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
headscale/docs/usage/connect/apple.md
nblock 29119bb7f4
Some checks are pending
Build / build (push) Waiting to run
Details
Build documentation / build (push) Waiting to run
Details
Build documentation / deploy (push) Blocked by required conditions
Details
Tests / test (push) Waiting to run
Details
Misc doc fixes (#2240) 
* Link back to node registration docs
* adjust wording in apple docs
* Mention client specific page to check if headscale works

Ref: #2238
2024-11-18 05:46:58 +01:00

2.5 KiB
Raw Blame History

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

Installation

Install the official Tailscale iOS client from the App Store.

Configuring the headscale URL

  • 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.

macOS

Installation

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

Configuring the headscale URL

Command line

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

tailscale login --login-server <YOUR_HEADSCALE_URL>

GUI

  • 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

tvOS

Installation

Install the official Tailscale tvOS client from the App Store.

!!! danger

**Don't** open the Tailscale App after installation!

Configuring the headscale URL

  • Open 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
  • Click the button Install VPN configuration and confirm the appearing popup by clicking the Allow button
  • Scan the QR code and follow the login procedure