https://github.com/wireguard/wireguard-android
Mirror only. Official repository is at https://git.zx2c4.com/wireguard-android
https://github.com/wireguard/wireguard-android
Last synced: 23 days ago
JSON representation
Mirror only. Official repository is at https://git.zx2c4.com/wireguard-android
- Host: GitHub
- URL: https://github.com/wireguard/wireguard-android
- Owner: WireGuard
- License: apache-2.0
- Created: 2018-04-27T13:07:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2026-06-29T18:47:36.000Z (4 months ago)
- Last Synced: 2026-09-28T02:26:53.902Z (about 1 month ago)
- Language: Kotlin
- Homepage:
- Size: 3.33 MB
- Stars: 1,626
- Watchers: 58
- Forks: 592
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: COPYING
Awesome Lists containing this project
README
# Android GUI for [WireGuard](https://www.wireguard.com/)
**[Download from the Play Store](https://play.google.com/store/apps/details?id=com.wireguard.android)**
This is an Android GUI for [WireGuard](https://www.wireguard.com/). It [opportunistically uses the kernel implementation](https://git.zx2c4.com/android_kernel_wireguard/about/), and falls back to using the non-root [userspace implementation](https://git.zx2c4.com/wireguard-go/about/).
## Building
```
$ git clone --recurse-submodules https://git.zx2c4.com/wireguard-android
$ cd wireguard-android
$ ./gradlew assembleRelease
```
macOS users may need [flock(1)](https://github.com/discoteq/flock).
## Embedding
The tunnel library is [on Maven Central](https://search.maven.org/artifact/com.wireguard.android/tunnel), alongside [extensive class library documentation](https://javadoc.io/doc/com.wireguard.android/tunnel).
```
implementation 'com.wireguard.android:tunnel:$wireguardTunnelVersion'
```
The library makes use of Java 8 features, so be sure to support those in your gradle configuration with [desugaring](https://developer.android.com/studio/write/java8-support#library-desugaring):
```
compileOptions {
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
coreLibraryDesugaringEnabled = true
}
dependencies {
coreLibraryDesugaring "com.android.tools:desugar_jdk_libs:2.0.3"
}
```
## Translating
Please help us translate the app into several languages on [our translation platform](https://crowdin.com/project/WireGuard).