bb7ea7cf9f
updates ENG-2805 Adds all of the kotlin build dependencies and a partial implementation of a LocalAPIClient in the front end, wired up via JNI. The general idea here is to mimic the architecture used on other Tailscale clients, where the front ends largely interact with the backend via "localapi". The LocalAPIClient in go has been renamed to LocalAPIService to avoid confusion with the implementation on the future client side in Kotlin. Some mild refactoring was done to make the localAPI invocations methods on the api service instead of App. Streaming notifier endpoints like watch-ipn-bus are not supported. We will build out a separate set of JNI methods for dealing with those. The jni package is moved under cmd where it is used. This constains mostly-complete implementation of the required localAPI data classes based on the pieces that are used by the iOS and macOS clients. The LocalAPIClient itself does not implement all of the endpoints, but is ready to do so when those APIs are needed by a UI component. Signed-off-by: Jonathan Nobels <jonathan@tailscale.com> |
9 months ago | |
|---|---|---|
| .github | 10 months ago | |
| .vscode | 10 months ago | |
| android | 9 months ago | |
| cmd | 9 months ago | |
| metadata/en-US | 4 years ago | |
| version | 1 year ago | |
| .gitignore | 10 months ago | |
| Dockerfile | 10 months ago | |
| LICENSE | 5 years ago | |
| Makefile | 9 months ago | |
| PATENTS | 5 years ago | |
| README.md | 1 year ago | |
| eclipse-formatter.xml | 10 months ago | |
| flake.lock | 3 years ago | |
| flake.nix | 3 years ago | |
| go.mod | 9 months ago | |
| go.sum | 9 months ago | |
README.md
Tailscale Android Client
Private WireGuard® networks made easy
Overview
This repository contains the open source Tailscale Android client.
Using
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 androidsdkwill install them)
Android Studio
- Install a Go runtime (https://go.dev/dl/).
- Install Android Studio (https://developer.android.com/studio).
- Start Android Studio, from the Welcome screen select "More Actions" and "SDK Manager".
- In the SDK manager, select the "SDK Tools" tab and install the "Android SDK Command-line Tools (latest)".
- Run
make androidsdkto 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.
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.