From 8aa40ed66c79d5053982d6cd46d7259f5f83e900 Mon Sep 17 00:00:00 2001 From: Florian Preinstorfer Date: Mon, 9 Sep 2024 13:15:39 +0200 Subject: [PATCH] wip --- README.md | 3 ++- docs/{iOS-client.md => apple-client.md} | 21 ++++++++++++--------- mkdocs.yml | 2 +- 3 files changed, 15 insertions(+), 11 deletions(-) rename docs/{iOS-client.md => apple-client.md} (69%) diff --git a/README.md b/README.md index 03802e27f90..8b82080fc15 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,8 @@ buttons available in the repo. | 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 | Yes [docs](./docs/iOS-client.md) | +| iOS | Yes [docs](./docs/apple-client.md#ios) | +| macOS | Yes [docs](./docs/apple-client.md#macos) | ## Running headscale diff --git a/docs/iOS-client.md b/docs/apple-client.md similarity index 69% rename from docs/iOS-client.md rename to docs/apple-client.md index 761dfcf056d..9e65be80248 100644 --- a/docs/iOS-client.md +++ b/docs/apple-client.md @@ -1,21 +1,24 @@ -# Connecting an iOS client +# Connecting an Apple client ## Goal -This documentation has the goal of showing how a user can use the official iOS [Tailscale](https://tailscale.com) client with `headscale`. +This documentation has the goal of showing how a user can use the official iOS and macOS [Tailscale](https://tailscale.com) clients with `headscale`. -## Installation +## macOS +TODO -Install the official Tailscale iOS client from the [App Store](https://apps.apple.com/app/tailscale/id1470499037). +## iOS + +### Installation -Ensure that the installed version is at least 1.38.1, as that is the first release to support alternate control servers. +Install the official Tailscale iOS client from the [App Store](https://apps.apple.com/app/tailscale/id1470499037). -## Configuring the headscale URL +### Configuring the headscale URL -!!! info "Apple devices" +!!! info "Instructions on your headscale instance" - An endpoint with information on how to connect your Apple devices - (currently macOS only) is available at `/apple` on your running instance. + An endpoint with information on how to connect your Apple device + is also available at `/apple` on your running instance. Ensure that the tailscale app is logged out before proceeding. diff --git a/mkdocs.yml b/mkdocs.yml index c14fd716035..b0f1a6e3d36 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -139,5 +139,5 @@ nav: - Remote CLI: remote-cli.md - Usage: - Android: android-client.md + - Apple: apple-client.md - Windows: windows-client.md - - iOS: iOS-client.md