Repository files navigation

https://tailscale.com

Private WireGuard® networks made easy

This repository contains the open source Tailscale Android client.

Help us test new features and bug-fixes before they ship to all users! Abeta testing track is available on the Play Store.

The app can be downloaded from theAmazon Appstore for Amazon Fire tablets and Fire TV devices.

TheF-Droid project builds the source code in this repository and maintains independently-built APKs. Note that F-Droid builds are not released, updated, or verified by the Tailscale team.

There are several options for setting up a build environment. The Android Studiopath is the most useful path for longer term development.

In all cases you will need:

• Go runtime
• Android SDK
• Android SDK components (make androidsdk will install them)

1. Install a Go runtime (https://go.dev/dl/).
2. Install Android Studio (https://developer.android.com/studio).
3. Start Android Studio, from the Welcome screen select "More Actions" and "SDK Manager".
4. In the SDK manager, select the "SDK Tools" tab and install the "Android SDK Command-line Tools (latest)".
5. Runmake androidsdk to install the necessary SDK components.

If you would prefer to avoid Android Studio, you can also install an AndroidSDK. The makefile detects common paths, sosudo apt install android-sdk issufficient on Debian / Ubuntu systems. To use an Android SDK installed in anon-standard location, set theANDROID_SDK_ROOT environment variable to thepath to the SDK.

If you installed Android Studio the tools may not be in your path. To get thecorrect tool path, runmake androidpath and export the provided path in yourshell.

The ktmft plugin on the default setting should be used to autoformat all Java, Kotlinand XML files in Android Studio. Enable "Format on Save".

If you wish to avoid installing software on your host system, a Docker based development strategy is available, you can build and start a shell with:

make docker-shell

Several other makefile recipes are available for setting up the proper build environment and running builds.

Note that the docker makefile recipes s will preserve the image and remove container on completion.If changes are made to the build environment or toolchain, cached docker images may need to be rebuilt.The docker build image name is parameterized in the makefile and changing it provides a simple means to do this.

If you have Nix 2.4 or later installed, a Nix development environment canbe set up with:

alias nix='nix --extra-experimental-features "nix-command flakes"'nix develop

make apkmake install

Usemake tag_release to bump the Android version code, update the versionname, and tag the current commit.

We only guarantee to support the latest Go release and any Go beta orrelease candidate builds (currently Go 1.14) in module mode. It mightwork in earlier Go versions or in GOPATH mode, but we're making noeffort to keep those working.

On the Fire Stick:

• Settings > My Fire TV > Developer Options > ADB Debugging > ON

Then some useful commands:

adb connect 10.2.200.213:5555adb install -r tailscale-fdroid.apkadb shell am start -n com.tailscale.ipn/com.tailscale.ipn.MainActivityadb shell pm uninstall com.tailscale.ipn

Please file any issues about this code or the hosted service onthe tailscale issue tracker.

under_construction.gif

PRs welcome, but we are still working out our contribution process andtooling.

We requireDeveloper Certificate ofOriginSigned-off-by lines in commits.

We areTailscale. Seehttps://tailscale.com/company for more about us and what we'rebuilding.

WireGuard is a registered trademark of Jason A. Donenfeld.