mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-29 18:33:05 +00:00
c3ef90a7f7
* Rename docs/ios-client.md to docs/apple-client.md. Add instructions for macOS; those are copied from the /apple endpoint and slightly modified. Fix doc links in the README. * Move infoboxes for /apple and /windows under the "Goal" section to the top. Those should be seen by users first as they contain *their* specific headscale URL. * Swap order of macOS and iOS to move "Profiles" further down. * Remove apple configuration profiles * Remove Tailscale versions hints * Mention /apple and /windows in the README along with their docs See: #2096
51 lines
1.9 KiB
Markdown
51 lines
1.9 KiB
Markdown
# Connecting an Apple client
|
|
|
|
## Goal
|
|
|
|
This documentation has the goal of showing how a user can use the official iOS and macOS [Tailscale](https://tailscale.com) 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](https://apps.apple.com/app/tailscale/id1470499037).
|
|
|
|
### 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](https://tailscale.com/kb/1065/macos-variants) 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
|