Skip to content

Commit

Permalink
wip
Browse files Browse the repository at this point in the history
  • Loading branch information
nblock committed Sep 9, 2024
1 parent 7be8796 commit b70442a
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 19 deletions.
18 changes: 9 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,15 @@ buttons available in the repo.

## Client OS support

| OS | Supports headscale |
| ------- | --------------------------------------------------------- |
| Linux | Yes |
| OpenBSD | Yes |
| FreeBSD | Yes |
| 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) |
| OS | Supports headscale |
| ------- | -------------------------------------------------------------------------------------------------- |
| Linux | Yes |
| OpenBSD | Yes |
| FreeBSD | Yes |
| Windows | Yes (see [docs](./docs/windows-client.md) and `/windows` on your headscale for more information) |
| Android | Yes (see [docs](./docs/android-client.md)) |
| macOS | Yes (see [docs](./docs/apple-client.md#macos) and `/apple` on your headscale for more information) |
| iOS | Yes (see [docs](./docs/apple-client.md#ios) and `/apple` on your headscale for more information) |

## Running headscale

Expand Down
21 changes: 12 additions & 9 deletions docs/iOS-client.md → docs/apple-client.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit b70442a

Please sign in to comment.