zaneschepke
/
wgtunnel
mirror of https://github.com/zaneschepke/wgtunnel.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
wgtunnel/README.md

62 lines
2.0 KiB
Markdown
Raw Normal View History

initial commit
2023-05-24 01:33:20 -04:00
<h1 align="center">
WG Tunnel
</h1>
<span align="center">
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
docs: update README.md
2023-07-09 19:57:07 -04:00
[![Discord Chat](https://img.shields.io/discord/1108285024631001111.svg)](https://discord.gg/rbRRNh6H7V)
initial commit
2023-05-24 01:33:20 -04:00
</span>
<span align="center">
[![Google Play](https://img.shields.io/badge/Google_Play-414141?style=for-the-badge&logo=google-play&logoColor=white)](https://play.google.com/store/apps/details?id=com.zaneschepke.wireguardautotunnel)
</span>
<span align="left">
This is an alternative Android Application for [WireGuard](https://www.wireguard.com/) with added features. Built using the [wireguard-android](https://github.com/WireGuard/wireguard-android) library and [Jetpack Compose](https://developer.android.com/jetpack/compose), this application was inspired by the official [WireGuard Android](https://github.com/WireGuard/wireguard-android) app.
</span>
<span align="center">
## Screenshots
<p float="center">
feat: add tunnel details screen and handshake monitoring Adds details screen which display details of tunnel configuration as well as last handshake and rx/tx of peer. Adds last handshake monitoring with statuses and thresholds. Adds handshake/connection notifications based on last successful handshake. Adds status LED next to tunnel on main screen. Fixes bug where first click on QR code could result in nothing happening if QR code module is being downloaded. Now shows message to user. Fixes bug where changes made after editing tunnel were not propagated to settings if that tunnel was configured as the default tunnel. Fixes bug causing crash if wrong config file selected Update README Closes #7, Closes #6
2023-07-17 16:32:16 -04:00
<img label="Main" style="padding-right:25px" src="asset/main_screen.png" width="200" />
feat: add split tunneling and tunnel configuration screen This adds a tunnel configuration screen where user can configure split application tunneling and change tunnel name. Additional QR code validation added to prevent adding of invalid QR codes to tunnels. Minor UI quality-of-life changes. Closes #3
2023-07-04 14:21:45 -04:00
<img label="Config" style="padding-left:25px" src="./asset/config_screen.png" width="200" />
initial commit
2023-05-24 01:33:20 -04:00
<img label="Settings" style="padding-left:25px" src="./asset/settings_screen.png" width="200" />
<img label="Support" style="padding-left:25px" src="./asset/support_screen.png" width="200" />
</p>
<span align="left">
## Inspiration
The inspiration for this app came from the inconvenience of constantly having to turn VPN off and on while on different networks. With there being no free solution to this problem, this app was created to meet that need.
## Features
* Add tunnels via .conf file
* Auto connect to VPN based on Wi-Fi SSID
docs: update README
2023-07-04 17:03:30 -04:00
* Split tunneling by application
initial commit
2023-05-24 01:33:20 -04:00
* Configurable Trusted Network list
* Optional auto connect on mobile data
* Automatic service restart after reboot
* Service will stay running in background after app has been closed
## Building
```
$ git clone https://github.com/zaneschepke/wgtunnel
$ cd wgtunnel
$ ./gradlew assembleRelease
```
docs: update README.md
2023-07-09 19:57:07 -04:00
</span>