WG Tunnel

An alternative FOSS Android client for WireGuard and AmneziaWG

Report a Bug · Request a Feature · Ask a Question

Table of Contents

• About
• Screenshots
• Features
• Building
• Translation
• Acknowledgements
• Contributing

About

WG Tunnel is an alternative Android client for WireGuard and AmneziaWG, inspired by the official WireGuard Android app. It fills gaps in the official client by adding advanced features like auto-tunneling, AmneziaWG support, different app modes like Lockdown (a custom kill switch for leak prevention), and Local Proxy (expose a tunnel over a local SOCKS5/HTTP proxy server) for enhanced privacy, censorship resistance, and flexibility.

Screenshots

Features

• Auto-Tunneling: Automatically activate tunnels based on your device's active network details.
• Deferred Endpoint Bootstrapping: Safely resolves endpoints and updates peers after the tunnel is up for better reliability and leak protection on startup.
• Handshake Monitoring: Real-time handshake monitoring for instant tunnel health feedback.
• AmneziaWG Support: Full support for AmneziaWG 2.0 through 3.1, providing robust censorship protection.
• Split Tunneling: Flexible support for routing specific apps or traffic through the VPN.
• Split & Encrypted DNS: Resolve DNS through the tunnel using plain DNS, DoT, or DoH, and optionally split by domain suffix (tunnel or system).
• Local Proxy Mode: Expose WireGuard tunnels over a local SOCKS5 or HTTP proxy to browsers or firewall apps (like AdGuard).
• Lockdown Mode: Advanced in-app kill switch that blocks all traffic while the tunnel is down.
• Quick Controls: Quick Settings tile and home screen shortcuts for easy toggling.
• Remote Control Support: Intent-based automation for controlling tunnels and auto-tunneling from automation apps (like Tasker).
• Dynamic DNS Handling: Automatically detect and update endpoints on server IP changes without requiring a restart.
• IPv6 Endpoints: Automatically upgrade to IPv6 endpoints or fall back to IPv4 based on network conditions without requiring a restart.
• Android TV Support: Full support for nearly all features on Android TV.

Building

The app consumes published core artifacts from Maven Central by default (libs.bundles.wgtunnel.core). That is enough for most app-only work.

git clone https://github.com/wgtunnel/android
cd android
./gradlew assembleDebug

Local full build (app + core)

To build against a local core checkout (native JNI, backend, parser, hevtunnel), clone core next to this repo:

parent/
  android/    # this repository
  core/       # https://github.com/wgtunnel/core

cd /path/to/parent
git clone https://github.com/wgtunnel/android
git clone https://github.com/wgtunnel/core
cd android

You also need the core build requirements (JDK 21, Android NDK, make, a C toolchain).

Then switch Gradle from Maven Central to the composite build:

1. In settings.gradle.kts, uncomment the local-dev includeBuild:

// Local dev
includeBuild("../core") {
	dependencySubstitution {
		substitute(module("com.wgtunnel.tunnel:backend"))
			.using(project(":backend"))
		substitute(module("com.wgtunnel.tunnel:backend-android-jni"))
			.using(project(":backend-android-jni"))
	}
}

2. In app/build.gradle.kts, comment out the Maven bundle and uncomment the local-dev implementations:

dependencies {
    implementation(project(":logcatter"))
    implementation(project(":networkmonitor"))
    // implementation(libs.bundles.wgtunnel.core)

    // Local dev
    implementation("com.wgtunnel.tunnel:backend")
    implementation("com.wgtunnel.tunnel:backend-android-jni")
}

3. Build from android/:

./gradlew assembleDebug

Do not commit those Gradle edits. Restore the commented includeBuild and Maven libs.bundles.wgtunnel.core dependency before opening a PR.

Translation

Help translate WG Tunnel on Crowdin.

Acknowledgements

Thank you to the following:

• All of the users that have helped contribute to the project with ideas, translations, feedback, bug reports, testing, and donations.
• WireGuard - Jason A. Donenfeld (https://github.com/WireGuard/wireguard-android)
• AmneziaWG - Amnezia Team (https://github.com/amnezia-vpn/amneziawg-android)
• JetBrains - For supporting open-source developers with free software licenses.

Contributing

Any contributions in the form of feedback, issues, code, or translations are welcome and much appreciated!

For PRs, please make sure to format before submitting.

./gradlew format

CI runs ./gradlew formatCheck, which uses the same files and style as format. If that job fails, run ./gradlew format and commit the result.

If your PR requires core changes, please link the associated PR.