From 003036a77904894343dd13e546d3590cc612ebf3 Mon Sep 17 00:00:00 2001
From: nicholas-yap <38109533+nicholas-yap@users.noreply.github.com>
Date: Fri, 17 Mar 2023 22:56:15 +0800
Subject: [PATCH] Update iOS compatibility and added iOS docs (#1264)

---
 CHANGELOG.md         |  1 +
 README.md            |  2 +-
 docs/iOS-client.md   | 25 +++++++++++++++++++++++++
 templates/apple.html | 32 ++++++++++++++++++++++----------
 4 files changed, 49 insertions(+), 11 deletions(-)
 create mode 100644 docs/iOS-client.md

diff --git a/CHANGELOG.md b/CHANGELOG.md
index cb2fbd19..994240b0 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 223f212b..d08987c4 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 00000000..9a8f1081
--- /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 d09f786b..3643e5fb 100644
--- a/templates/apple.html
+++ b/templates/apple.html
@@ -56,7 +56,7 @@
     </p>
     <ul>
       <li>
-        <a href="https://apps.apple.com/ca/app/tailscale/id1475387142?mt=12"
+        <a href="https://apps.apple.com/app/tailscale/id1475387142"
           >macOS - AppStore Client</a
         >.
       </li>
@@ -122,18 +122,22 @@
     </ul>
     <p>Restart Tailscale.app and log in.</p>
     <h1>headscale: iOS configuration</h1>
-    <h2>Recent Tailscale versions (1.38.0 and higher)</h2>
+    <h2>Recent Tailscale versions (1.38.1 and higher)</h2>
     <p>
-      Tailscale 1.38 on
-      <a href="https://apps.apple.com/us/app/tailscale/id1470499037?ls=1"
-        >iOS</a
-      >
+      Tailscale 1.38.1 on
+      <a href="https://apps.apple.com/app/tailscale/id1470499037">iOS</a>
       added a configuration option to allow user to set an "Alternate
       Coordination server". This can be used to connect to your headscale
       server.
     </p>
     <h3>GUI</h3>
     <ol>
+      <li>
+        Install the official Tailscale iOS client from the
+        <a href="https://apps.apple.com/app/tailscale/id1470499037"
+          >App store</a
+        >
+      </li>
       <li>
         Open Tailscale and make sure you are <i>not</i> logged in to any account
       </li>
@@ -143,16 +147,24 @@
         "TV Provider"
       </li>
       <li>
-        Find Tailscale and enter the settings
-        <ol>
+        Find Tailscale and select it
+        <ul>
           <li>
             If the iOS device was previously logged into Tailscale, switch the
             "Reset Keychain" toggle to "on"
           </li>
-        </ol>
+        </ul>
       </li>
       <li>Enter "{{.URL}}" under "Alternate Coordination Server URL"</li>
-      <li>Open Tailscale and log in to the Headscale server</li>
+      <li>
+        Restart the app by closing it from the iOS app switcher, open the app
+        and select the regular sign in option <i>(non-SSO)</i>. It should open
+        up to the headscale authentication page.
+      </li>
+      <li>
+        Enter your credentials and log in. Headscale should now be working on
+        your iOS device
+      </li>
     </ol>
   </body>
 </html>