https://github.com/netbirdio/android-client
Connect your devices into a single secure private WireGuard®-based mesh network with SSO/MFA and simple access controls.
https://github.com/netbirdio/android-client
android golang gomobile mesh mesh-networks nat-transversal netbird vpn wireguard wireguard-vpn zero-trust-network-access
Last synced: 3 months ago
JSON representation
Connect your devices into a single secure private WireGuard®-based mesh network with SSO/MFA and simple access controls.
- Host: GitHub
- URL: https://github.com/netbirdio/android-client
- Owner: netbirdio
- License: gpl-3.0
- Created: 2024-02-27T09:07:34.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-12-04T17:58:11.000Z (over 1 year ago)
- Last Synced: 2025-03-31T15:03:37.147Z (over 1 year ago)
- Topics: android, golang, gomobile, mesh, mesh-networks, nat-transversal, netbird, vpn, wireguard, wireguard-vpn, zero-trust-network-access
- Language: TypeScript
- Homepage: https://netbird.io
- Size: 45.4 MB
- Stars: 65
- Watchers: 9
- Forks: 19
- Open Issues: 21
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-foss-android-apps - NetBird
README
Start using NetBird at netbird.io
See Documentation
Join our Slack channel
# NetBird Android client
The NetBird Android client allows connections from mobile devices running Android to private resources in the NetBird network.
## Screenshots
## Install
You can download and install the app from the Google Play Store:
[
](https://play.google.com/store/apps/details?id=io.netbird.client)
## Building from source
### Requirements
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/)
### Prepare development environment
1. Close all repositories:
> assuming you use a path like ~/projects locally
```shell
mkdir ~/projects
cd projects
# clone netbird repo
git clone --recurse-submodules git@github.com:netbirdio/android-client.git
```
2. 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.
3. Export JDK and Android home vars, on macOS they are: (please contribute with Linux equivalent)
```shell
# replace with your name
export ANDROID_HOME=/Users//Library/Android/sdk
export JAVA_HOME=/Applications/Android Studio.app/Contents/jbr/Contents/Home
```
4. Install NDK and CMake
```shell
cd ~/projects/android-client
$ANDROID_HOME/cmdline-tools/latest/bin/sdkmanager --install "ndk;23.1.7779620"
```
### Generate debug bundle
Follow the steps to run locally until the step 5 then run the following steps:
1. Build Go agent library
```shell
cd ~/projects/android-client
./build-android-lib.sh
```
2. Run gradlew
```shell
cd ~/projects/android-client/android
./gradlew bundleDebug -PversionCode=123 -PversionName=1.2.3
```