zaneschepke
/
wgtunnel
mirror of https://github.com/zaneschepke/wgtunnel.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Mirror of WG Tunnel
117 Commits 126 Branches 93 Tags 6.2 MiB
Kotlin 99.8%
Ruby 0.2%
Go to file
dependabot[bot] 542e0feb4c
build(deps): bump com.android.application 
Bumps com.android.application from 8.3.0-rc02 to 8.4.0-alpha12.

---
updated-dependencies:
- dependency-name: com.android.application
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <support@github.com>
 		2024-03-01 13:40:07 +00:00
.github Merge pull request #105 from zaneschepke/dependabot/github_actions/actions/upload-artifact-4.3.1 2024-02-19 06:59:32 -05:00
app fix: ui bug and graphene notification 2024-02-20 16:17:34 -05:00
asset chore: add icon 2024-01-20 18:15:36 -05:00
buildSrc fix: ui bug and graphene notification 2024-02-20 16:17:34 -05:00
fastlane fix: ui bug and graphene notification 2024-02-20 16:17:34 -05:00
gradle build(deps): bump com.android.application 2024-03-01 13:40:07 +00:00
.editorconfig fix: tunnel disable frozen 2024-01-08 19:06:40 -05:00
.gitignore add: build and release CI 2023-11-08 22:11:52 -05:00
Gemfile change: build pipeline to fastlane deploy 2023-11-10 18:32:35 -05:00
LICENSE initial commit 2023-06-18 21:43:22 -04:00
README.md feat: migrate to forked lib 2024-02-18 23:28:06 -05:00
build.gradle.kts feat: add basic kernel support 2023-12-20 23:17:15 -05:00
gradle.properties refactor: objectbox to room 2023-09-15 07:24:19 -04:00
gradlew initial commit 2023-06-18 21:43:22 -04:00
gradlew.bat initial commit 2023-06-18 21:43:22 -04:00
settings.gradle.kts feat: migrate to forked lib 2024-02-18 23:28:06 -05:00

README.md

WG Tunnel

License: MIT Discord Chat

Google Play F-Droid

This is an alternative Android Application for WireGuard with added features. Built using the wireguard-android library and Jetpack Compose, this application was inspired by the official WireGuard Android app.

Screenshots

Inspiration

The original inspiration for this app came from the inconvenience of having to manually turn VPN off and on while on different networks. This app was created to offer a free solution to this problem.

Features

  • Add tunnels via .conf file, zip, manual entry, or QR code
  • Auto connect to VPN based on Wi-Fi SSID, ethernet, or mobile data
  • Split tunneling by application with search
  • WireGuard support for kernel and userspace modes
  • Always-On VPN support
  • Export tunnels to zip
  • Quick tile support for VPN toggling
  • Static shortcuts support for primary tunnel for automation integration
  • Intent automation support for all tunnels
  • Automatic service restart after reboot
  • Battery preservation measures

Docs (WIP)

Basic documentation of the feature and behaviors of this app can be found here.

The repository for these docs can be found here.

Building

$ git clone https://github.com/zaneschepke/wgtunnel
$ cd wgtunnel

Create a personal access token (classic) in GitHuv to be able to pull the wireguard-android github dependencies from GitHub packages as documented here.

Alternatively, you can clone wireguard-android and run the following command to publish the dependency to your local maven repository (requires you have maven installed). This is the ideal approach if you intent to make changes to this lib.

$ git clone https://github.com/zaneschepke/wireguard-android
$ cd wireguard-android
$ brew install maven
$ ./gradlew publishToMavenLocal

The wireguard-android dependency is a fork of the official wireguard-android library.

Add the following lines to local.properties file:

GH_USER=<your github username>
GH_TOKEN=<the personal access token with read package permission you just created>

And then build the app:

$ ./gradlew assembleDebug