diff --git a/CHANGELOG.md b/CHANGELOG.md index cb2fbd1..994240b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,7 @@ - Adding "configtest" CLI command. [#1230](https://github.com/juanfont/headscale/pull/1230) - Add documentation on connecting with iOS to `/apple` [#1261](https://github.com/juanfont/headscale/pull/1261) +- Update iOS compatibility and added documentation for iOS [#1264](https://github.com/juanfont/headscale/pull/1264) ## 0.20.0 (2023-02-03) diff --git a/README.md b/README.md index 223f212..d08987c 100644 --- a/README.md +++ b/README.md @@ -75,7 +75,7 @@ one of the maintainers. | macOS | Yes (see `/apple` on your headscale for more information) | | Windows | Yes [docs](./docs/windows-client.md) | | Android | Yes [docs](./docs/android-client.md) | -| iOS | Not yet | +| iOS | Yes [docs](./docs/iOS-client.md) | ## Running headscale diff --git a/docs/iOS-client.md b/docs/iOS-client.md new file mode 100644 index 0000000..9a8f108 --- /dev/null +++ b/docs/iOS-client.md @@ -0,0 +1,25 @@ +# Connecting an iOS client + +## Goal + +This documentation has the goal of showing how a user can use the official iOS [Tailscale](https://tailscale.com) client with `headscale`. + +## Installation + +Install the official Tailscale iOS client from the [App Store](https://apps.apple.com/app/tailscale/id1470499037). + +Ensure that the installed version is at least 1.38.1, as that is the first release to support alternate control servers. + +## Configuring the headscale URL + +Ensure that the tailscale app is logged out before proceeding. + +Go to iOS settings, scroll down past game center and tv provider to the tailscale app and select it. The headscale URL can be entered into the _"ALTERNATE COORDINATION SERVER URL"_ box. + +> **Note** +> +> If the app was previously logged into tailscale, toggle on the _Reset Keychain_ switch. + +Restart the app by closing it from the iOS app switcher, open the app and select the regular _Sign in_ option (non-SSO), and it should open up to the headscale authentication page. + +Enter your credentials and log in. Headscale should now be working on your iOS device. diff --git a/templates/apple.html b/templates/apple.html index d09f786..3643e5f 100644 --- a/templates/apple.html +++ b/templates/apple.html @@ -56,7 +56,7 @@
Restart Tailscale.app and log in.
- Tailscale 1.38 on - iOS + Tailscale 1.38.1 on + iOS added a configuration option to allow user to set an "Alternate Coordination server". This can be used to connect to your headscale server.