mirror of
https://github.com/juanfont/headscale.git
synced 2024-11-29 18:33:05 +00:00
add details on how to use the android app
This commit is contained in:
parent
f9c4d577e2
commit
10d566c946
2 changed files with 28 additions and 9 deletions
18
README.md
18
README.md
|
@ -67,15 +67,15 @@ one of the maintainers.
|
||||||
|
|
||||||
## Client OS support
|
## Client OS support
|
||||||
|
|
||||||
| OS | Supports headscale |
|
| OS | Supports headscale |
|
||||||
| ------- | ----------------------------------------------------------------------------------------------------------------- |
|
| ------- | --------------------------------------------------------- |
|
||||||
| Linux | Yes |
|
| Linux | Yes |
|
||||||
| OpenBSD | Yes |
|
| OpenBSD | Yes |
|
||||||
| FreeBSD | Yes |
|
| FreeBSD | Yes |
|
||||||
| macOS | Yes (see `/apple` on your headscale for more information) |
|
| macOS | Yes (see `/apple` on your headscale for more information) |
|
||||||
| Windows | Yes [docs](./docs/windows-client.md) |
|
| Windows | Yes [docs](./docs/windows-client.md) |
|
||||||
| Android | [You need to compile the client yourself](https://github.com/juanfont/headscale/issues/58#issuecomment-885255270) |
|
| Android | Yes [docs](./docs/android-client.md) |
|
||||||
| iOS | Not yet |
|
| iOS | Not yet |
|
||||||
|
|
||||||
## Running headscale
|
## Running headscale
|
||||||
|
|
||||||
|
|
19
docs/android-client.md
Normal file
19
docs/android-client.md
Normal file
|
@ -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: <https://github.com/tailscale/tailscale-android/pull/55>
|
||||||
|
|
||||||
|
After saving and restarting the app, selecting the regular _Sign in_ option (non-SSO) should open up the headscale authentication page.
|
Loading…
Reference in a new issue