Start using NetBird at netbird.io
See Documentation
Join our Slack channel
The NetBird Android client allows connections from mobile devices running Android to private resources in the NetBird network.
You can download and install the app from the Google Play Store:
NetBird uses a discussion-first workflow across all its repositories. Bug reports and feature requests for the Android client start in netbird Discussions, not as issues here.
| What you want to do | Where to go |
|---|---|
| Report a bug, regression, or unexpected behavior | Issue Triage |
| Request a feature or share an idea | Ideas & Feature Requests |
| Ask about setup, configuration, or self-hosting | Q&A / Support |
| Report a security vulnerability | Security policy, never a public thread |
Our team triages each discussion. Validated reports become issues in this repository, linked back to the discussion. See How to use Discussions, Issues, and Pull Requests for the full workflow.
We need the following software:
- Java 1.11. Usually comes with Android Studio
- android studio initialized with jdk and emulator (not covered here, is a req from android-client project)
- gradle (https://gradle.org/install/)
- Close all repositories:
assuming you use a path like ~/projects locally
mkdir ~/projects cd projects # clone netbird repo git clone --recurse-submodules [email protected]:netbirdio/android-client.git
- Checkout the repositories to the branches you want to test. If you want the latest, check the status information on your IDE or on https://github.com and verify the branch list and commit history.
- Export JDK and Android home vars, on macOS they are: (please contribute with Linux equivalent)
# replace <USERNAME> with your name export ANDROID_HOME=/Users/<USERNAME>/Library/Android/sdk export JAVA_HOME=/Applications/Android Studio.app/Contents/jbr/Contents/Home
- Install NDK and CMake
cd ~/projects/android-client $ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install "ndk;23.1.7779620"
Follow the steps to run locally until the step 5 then run the following steps:
- Build Go agent library
cd ~/projects/android-client ./build-android-lib.sh
- Run gradlew
cd ~/projects/android-client/android ./gradlew bundleDebug -PversionCode=123 -PversionName=1.2.3