From 10d566c94690e475fa187809c09c722d902335a7 Mon Sep 17 00:00:00 2001 From: Rasmus Moorats Date: Tue, 2 Aug 2022 09:49:28 +0300 Subject: [PATCH] add details on how to use the android app --- README.md | 18 +++++++++--------- docs/android-client.md | 19 +++++++++++++++++++ 2 files changed, 28 insertions(+), 9 deletions(-) create mode 100644 docs/android-client.md diff --git a/README.md b/README.md index d088767..0cfed4d 100644 --- a/README.md +++ b/README.md @@ -67,15 +67,15 @@ one of the maintainers. ## 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 | [You need to compile the client yourself](https://github.com/juanfont/headscale/issues/58#issuecomment-885255270) | -| iOS | Not yet | +| 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 | Not yet | ## Running headscale diff --git a/docs/android-client.md b/docs/android-client.md new file mode 100644 index 0000000..d4f8129 --- /dev/null +++ b/docs/android-client.md @@ -0,0 +1,19 @@ +# Connecting an Android client + +## Goal + +This documentation has the goal of showing how a user can use the official Android [Tailscale](https://tailscale.com) client with `headscale`. + +## Installation + +Install the official Tailscale Android client from the [Google Play Store](https://play.google.com/store/apps/details?id=com.tailscale.ipn) or [F-Droid](https://f-droid.org/packages/com.tailscale.ipn/). + +Ensure that the installed version is at least 1.30.0, as that is the first release to support custom URLs. + +## Configuring the headscale URL + +After opening the app, the kebab menu icon (three dots) on the top bar on the right must be repeatedly opened and closed until the _Change server_ option appears in the menu. This is where you can enter your headscale URL. + +A screen recording of this process can be seen in the `tailscale-android` PR which implemented this functionality: + +After saving and restarting the app, selecting the regular _Sign in_ option (non-SSO) should open up the headscale authentication page.