You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Andrea Gottardo 07c65a00d0 android: add app_restrictions.xml and manifest entry
Fixes ENG-2926

Adds an `app_restrictions.xml` file with our available MDM policies, and a new entry to the AndroidManifest.xml file to declare its availability.

Signed-off-by: Andrea Gottardo <andrea@gottardo.me>
7 months ago
.github android: switch to using gomobile 8 months ago
.vscode use network callback to update DNS config when network changes (#147) 10 months ago
android android: add app_restrictions.xml and manifest entry 7 months ago
android_legacy *: add a CI check for license headers and fix all files 8 months ago
cmd android: ViewModel cleanup 8 months ago
libtailscale android: add Client.postMultipart 7 months ago
metadata/en-US metadata/en-US/images/phoneScreenshots: add screenshots for F-Droid 4 years ago
scripts *: add a CI check for license headers and fix all files 8 months ago
tool *: introduce tool/go following our common pattern 8 months ago
version version: handle whitespace in ${mod_version} (#141) 12 months ago
.gitignore android: switch to using gomobile 8 months ago
Dockerfile Dockerfile: update to use go 1.22 (#163) 9 months ago
LICENSE all: initial commit 4 years ago
Makefile Makefile: add help text to make commands 7 months ago
PATENTS all: initial commit 4 years ago
README.md android: use ktfmt formatting and use scaffold consistently across all views (#217) 8 months ago
eclipse-formatter.xml use network callback to update DNS config when network changes (#147) 10 months ago
flake.lock flake.*: add Nix support for establishing a development environment 3 years ago
flake.nix flake.*: add Nix support for establishing a development environment 3 years ago
go.mod android: add Client.postMultipart 7 months ago
go.sum android: add Client.postMultipart 7 months ago
go.toolchain.rev *: introduce tool/go following our common pattern 8 months ago

README.md

Tailscale Android Client

https://tailscale.com

Private WireGuard® networks made easy

Overview

This repository contains the open source Tailscale Android client.

Using

Get it on F-Droid Get it on Google Play

Preparing a build environment

There are several options for setting up a build environment. The Android Studio path 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)

Android Studio

  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. Run make androidsdk to install the necessary SDK components.

If you would prefer to avoid Android Studio, you can also install an Android SDK. The makefile detects common paths, so sudo apt install android-sdk is sufficient on Debian / Ubuntu systems. To use an Android SDK installed in a non-standard location, set the ANDROID_SDK_ROOT environment variable to the path to the SDK.

If you installed Android Studio the tools may not be in your path. To get the correct tool path, run make androidpath and export the provided path in your shell.

Code Formatting

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

Docker

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 dockershell

Nix

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

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

Building

make apk
make install

Building a release

Use make tag_release to bump the Android version code, update the version name, and tag the current commit.

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

Google Sign-In

Google Sign-In support relies on configuring a Google API Console project with the app identifier and signing key hashes. The official release uses the app identifier com.tailscale.ipn; custom builds should use a different identifier.

Running in the Android emulator

By default, the android emulator uses an older version of OpenGL ES, which results in a black screen when opening the Tailscale app. To fix this, with the emulator running:

  • Open the three-dots menu to access emulator settings
  • To to Settings > Advanced
  • Set "OpenGL ES API level" to "Renderer maximum (up to OpenGL ES 3.1)"
  • Close the emulator.
  • In Android Studio's emulator view (that lists all your emulated devices), hit the down arrow by the virtual device and select "Cold boot now" to restart the emulator from scratch.

The Tailscale app should now render correctly.

Additionally, there seems to be a bug that prevents using the system-level Google sign-in option (the one that pops up a system-level UI to select your Google account). You can work around this by selecting "Other" at the sign-in screen, and then selecting Google from the next screen.

Developing on a Fire Stick TV

On the Fire Stick:

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

Then some useful commands:

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

Bugs

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

Contributing

under_construction.gif

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

We require Developer Certificate of Origin Signed-off-by lines in commits.

About Us

We are apenwarr, bradfitz, crawshaw, danderson, dfcarney, from Tailscale Inc. You can learn more about us from our website.

WireGuard is a registered trademark of Jason A. Donenfeld.