Go to file

Harsh Shandilya 1bb8a10633 ui: remove unnecessary boolean check This check was added in `3c31c340d8` when the kernel module loader was introduced into the app lifecycle, to avoid attempting to start a root shell twice. When the module loader was removed in `a03ad51622`, this flag was accidentally left in when it should have been deleted. Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>		2022-05-26 06:01:02 +05:30
.idea	idea: squelch XML codestyle warning	2022-05-26 06:01:02 +05:30
gradle/wrapper	gradle: bump wrapper to 7.3.3	2022-01-08 15:30:11 +05:30
tunnel	tools: bump deps	2022-05-16 19:15:07 +02:00
ui	ui: remove unnecessary boolean check	2022-05-26 06:01:02 +05:30
.gitignore	gitignore: add gradlew.bat	2020-06-25 01:36:31 +05:30
.gitmodules	Migrate tunnel related classes to tunnel/ Gradle module	2020-03-09 19:24:26 +05:30
build.gradle	gradle: bump AGP and Kotlin	2022-04-08 03:08:22 +05:30
COPYING	global: move to Apache 2.0	2018-07-06 16:28:46 +02:00
gradle.properties	gradle: update property set with AGP 7 experimental flags	2021-07-29 12:30:07 +05:30
gradlew	gradle: bump wrapper to 7.2	2021-10-25 22:38:00 +05:30
README.md	README: re-add desugaring block	2021-10-29 17:19:00 +02:00
settings.gradle	gradle: bump AGP and Kotlin	2022-04-08 03:08:22 +05:30
sync-crowdin.sh	build: add crowdin syncer script and use it	2020-10-14 17:16:36 +02:00
version.gradle	version: bump	2022-05-16 19:17:40 +02:00

README.md

Android GUI for WireGuard

Download from the Play Store

This is an Android GUI for WireGuard. It opportunistically uses the kernel implementation, and falls back to using the non-root userspace implementation.

Building

$ git clone --recurse-submodules https://git.zx2c4.com/wireguard-android
$ cd wireguard-android
$ ./gradlew assembleRelease

macOS users may need flock(1).

Embedding

The tunnel library is on Maven Central, alongside extensive class library documentation.

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:

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
    coreLibraryDesugaringEnabled = true
}
dependencies {
    coreLibraryDesugaring "com.android.tools:desugar_jdk_libs:1.1.5"
}

Translating

Please help us translate the app into several languages on our translation platform.