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

111 lines
4.2 KiB
Markdown
Raw Normal View History

initial commit
2023-05-24 01:33:20 -04:00
<h1 align="center">
WG Tunnel
</h1>
docs: Update README.md
2023-09-26 12:58:37 -04:00
<div align="center">
initial commit
2023-05-24 01:33:20 -04:00
chore: update chats
2024-04-20 18:36:40 -04:00
[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?style=for-the-badge&logo=discord&logoColor=white)](https://discord.gg/rbRRNh6H7V)
[![X Community](https://img.shields.io/badge/X-000000?style=for-the-badge&logo=x&logoColor=white)](https://twitter.com/i/communities/1780655267685736818)
[![Telegram](https://img.shields.io/badge/Telegram-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white)](https://t.me/wgtunnel)
initial commit
2023-05-24 01:33:20 -04:00
docs: Update README.md
2023-09-26 12:58:37 -04:00
</div>
initial commit
2023-05-24 01:33:20 -04:00
docs: Update README.md
2023-09-26 12:58:37 -04:00
<div align="center">
initial commit
2023-05-24 01:33:20 -04:00
[![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)
docs: Update README.md
2023-09-26 12:58:37 -04:00
[![F-Droid](https://img.shields.io/static/v1?style=for-the-badge&message=F-Droid&color=1976D2&logo=F-Droid&logoColor=FFFFFF&label=)](https://f-droid.org/packages/com.zaneschepke.wireguardautotunnel/)
initial commit
2023-05-24 01:33:20 -04:00
docs: Update README.md
2023-09-26 12:58:37 -04:00
</div>
docs: update README.md
2023-07-27 17:19:25 -04:00
docs: Update README.md
2023-09-26 12:58:37 -04:00
<div align="left">
initial commit
2023-05-24 01:33:20 -04:00
fix: mobile data tunneling Fixes a bug where mobile data tunneling was not working properly in certain scenarios. Fixes an issue where the new floating action button was not working correctly on AndroidTV. Improved local logging. Additional refactors and optimizations.
2024-05-30 23:10:28 -04:00
This is an alternative Android Application for [WireGuard](https://www.wireguard.com/)
and [AmneziaWG](https://docs.amnezia.org/documentation/amnezia-wg/) with added
fix: tunnel disable frozen Fixes a bug where after toggling a tunnel so many times it would eventually get stuck in the on position. This was also impacting auto-tunneling reliability. Fixes a bug where clicking the email button on the support page would not populate the "to" email field. Fixes a bug where you could not save a tunnel without having configured DNS. Added a dialog to prompt user if they are deleting a tunnel. Added battery optimization disable request when first launching auto-tunneling. Format to kotlinlang standards. Fix ci google play deploy. Closes #63
2024-01-06 04:06:21 -05:00
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.
initial commit
2023-05-24 01:33:20 -04:00
docs: Update README.md
2023-09-26 12:58:37 -04:00
</div>
initial commit
2023-05-24 01:33:20 -04:00
docs: Update README.md
2023-09-26 12:58:37 -04:00
<div align="center">
initial commit
2023-05-24 01:33:20 -04:00
## Screenshots
<p float="center">
docs: update README
2024-01-01 11:53:04 -05:00
<img label="Main" style="padding-right:25px" src="fastlane/metadata/android/en-US/images/phoneScreenshots/main_screen.png" width="200" />
<img label="Config" style="padding-left:25px" src="fastlane/metadata/android/en-US/images/phoneScreenshots/config_screen.png" width="200" />
<img label="Settings" style="padding-left:25px" src="fastlane/metadata/android/en-US/images/phoneScreenshots/settings_screen.png" width="200" />
<img label="Support" style="padding-left:25px" src="fastlane/metadata/android/en-US/images/phoneScreenshots/support_screen.png" width="200" />
initial commit
2023-05-24 01:33:20 -04:00
</p>
docs: Update README.md
2023-09-26 12:58:37 -04:00
<div align="left">
initial commit
2023-05-24 01:33:20 -04:00
## Inspiration
fix: tunnel disable frozen Fixes a bug where after toggling a tunnel so many times it would eventually get stuck in the on position. This was also impacting auto-tunneling reliability. Fixes a bug where clicking the email button on the support page would not populate the "to" email field. Fixes a bug where you could not save a tunnel without having configured DNS. Added a dialog to prompt user if they are deleting a tunnel. Added battery optimization disable request when first launching auto-tunneling. Format to kotlinlang standards. Fix ci google play deploy. Closes #63
2024-01-06 04:06:21 -05:00
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.
initial commit
2023-05-24 01:33:20 -04:00
## Features
chore: update descriptions
2023-11-23 22:14:29 -05:00
* Add tunnels via .conf file, zip, manual entry, or QR code
docs: update readme, add security
2024-03-30 23:16:19 -04:00
* Auto connect to tunnels based on Wi-Fi SSID, ethernet, or mobile data
chore: update README.md
2023-09-04 02:51:05 -04:00
* Split tunneling by application with search
docs: update README
2024-01-01 11:53:04 -05:00
* WireGuard support for kernel and userspace modes
add version metadata
2024-05-10 23:53:13 -04:00
* Amnezia support for userspace mode for DPI/censorship protection
chore: update README.md
2024-08-17 23:12:03 -04:00
* Pre/Post Up/Down scripts support for all modes on a rooted device
docs: update README
2024-01-01 11:53:04 -05:00
* Always-On VPN support
add version metadata
2024-05-10 23:53:13 -04:00
* Export Amnezia and WireGuard tunnels to zip
docs: update readme, add security
2024-03-30 23:16:19 -04:00
* Quick tile support for tunnel toggling, auto-tunneling
* Static shortcuts support for tunnel toggling, auto-tunneling
chore: update descriptions
2023-11-23 22:14:29 -05:00
* Intent automation support for all tunnels
chore: update README.md
2024-08-17 23:12:03 -04:00
* Automatic auto-tunneling service and/or tunnel restart after reboot and app update
docs: update README
2024-01-01 11:53:04 -05:00
* Battery preservation measures
docs: update readme, add security
2024-03-30 23:16:19 -04:00
* Restart tunnel on ping failure (beta)
initial commit
2023-05-24 01:33:20 -04:00
docs: update readme
2024-06-01 03:00:41 -04:00
## Fdroid
docs: add link to README
2024-01-14 12:06:29 -05:00
docs: update readme
2024-06-01 03:00:41 -04:00
Want updates faster?
docs: add link to README
2024-01-14 12:06:29 -05:00
fix: crashing and pin lock Re-enabled pin lock after disablement from crashes. Fixed crashing issues. Closes #237 Fixed bug where pin lock will no longer initialize if never not enabled/in use. Improved tunnel control tile performance. Fix bad address crash when user enters bad addresses into allowedIps. Closes #229 Disabled auto rotate Closes #212 Add restart on boot toggle to make restart of services feature more obvious and configurable.
2024-06-18 23:08:15 -04:00
Check out my personal [fdroid repository](https://github.com/zaneschepke/fdroid) to get updates the
moment they are released.
docs: add link to README
2024-01-14 12:06:29 -05:00
docs: update readme
2024-06-01 03:00:41 -04:00
## Docs
chore: add code of conduct
2024-04-20 13:52:28 -04:00
fix: crashing and pin lock Re-enabled pin lock after disablement from crashes. Fixed crashing issues. Closes #237 Fixed bug where pin lock will no longer initialize if never not enabled/in use. Improved tunnel control tile performance. Fix bad address crash when user enters bad addresses into allowedIps. Closes #229 Disabled auto rotate Closes #212 Add restart on boot toggle to make restart of services feature more obvious and configurable.
2024-06-18 23:08:15 -04:00
Information about features, behaviors, and answers to common questions can be found in the
app [documentation](https://zaneschepke.com/wgtunnel-docs/overview.html).
docs: update readme
2024-06-01 03:00:41 -04:00
The repository for these docs can be found [here](https://github.com/zaneschepke/wgtunnel-docs).
chore: update README
2024-04-20 13:57:33 -04:00
chore: update README.md
2024-04-20 17:09:36 -04:00
## Translation
chore: add Weblate details to README
2024-04-20 14:30:21 -04:00
fix: mobile data tunneling Fixes a bug where mobile data tunneling was not working properly in certain scenarios. Fixes an issue where the new floating action button was not working correctly on AndroidTV. Improved local logging. Additional refactors and optimizations.
2024-05-30 23:10:28 -04:00
This app is using [Weblate](https://weblate.org) to assist with translations.
chore: add Weblate details to README
2024-04-20 14:30:21 -04:00
fix: mobile data tunneling Fixes a bug where mobile data tunneling was not working properly in certain scenarios. Fixes an issue where the new floating action button was not working correctly on AndroidTV. Improved local logging. Additional refactors and optimizations.
2024-05-30 23:10:28 -04:00
Help translate WG Tunnel into your language
at [Hosted Weblate](https://hosted.weblate.org/engage/wg-tunnel/).\
chore: update README.md
2024-04-20 17:09:36 -04:00
[![Translation status](https://hosted.weblate.org/widgets/wg-tunnel/-/multi-auto.svg)](https://hosted.weblate.org/engage/wg-tunnel/)
initial commit
2023-05-24 01:33:20 -04:00
## Building
fix: tunnel disable frozen Fixes a bug where after toggling a tunnel so many times it would eventually get stuck in the on position. This was also impacting auto-tunneling reliability. Fixes a bug where clicking the email button on the support page would not populate the "to" email field. Fixes a bug where you could not save a tunnel without having configured DNS. Added a dialog to prompt user if they are deleting a tunnel. Added battery optimization disable request when first launching auto-tunneling. Format to kotlinlang standards. Fix ci google play deploy. Closes #63
2024-01-06 04:06:21 -05:00
initial commit
2023-05-24 01:33:20 -04:00
```
$ git clone https://github.com/zaneschepke/wgtunnel
$ cd wgtunnel
feat: migrate to forked lib Migrated app to a forked version of wireguard-android to enable development work on features that require changes to the core lib, like #107 #104 #87 #52 #6 Improved first launch flow by change vpn permission to only launch on first tunnel start Changed to proper database seeding strategy Updated README to account for GitHub packages auth requirement Migrated from deprecated UI components and libs Bump versions
2024-02-18 23:28:06 -05:00
```
And then build the app:
feat: auto-tunneling flexibility Added tunnel settings feature where users can configure a tunnel to be used on certain SSID or with mobile data. Closes #50 Added feature where if a tunnel was active when phone restarted, the app will start that tunnel on boot. Removed automatic auto-tunnel toggling/override from the tunnel tile and app shortcuts as it can cause undesirable behavior. Added second tile to control auto-tunneling pause/resume state from a tile. Added two additional static shortcuts to be able to control auto-tunneling pause/resume state from shortcuts. Fixed bug where crashes can happen from serializing and deserializing tunnel configs by removing the need for serialization of tunnel configs. Refactored logic of watcher and tunnel service to make state more predictable. #127 Fixed bug where rapidly toggling tunnels can cause crashes. Closes #145 Improved how tunnels are manually toggled from one to another. Improved logic/storage around primary tunnel behavior. Fixes issue where info level logs were not populating on release builds. Increase allowed name length displayed in UI. Closes #143 Fixes bug where androidTV could crash in certain situations. Bump versions. Updated screenshots.
2024-03-29 23:53:41 -04:00
feat: migrate to forked lib Migrated app to a forked version of wireguard-android to enable development work on features that require changes to the core lib, like #107 #104 #87 #52 #6 Improved first launch flow by change vpn permission to only launch on first tunnel start Changed to proper database seeding strategy Updated README to account for GitHub packages auth requirement Migrated from deprecated UI components and libs Bump versions
2024-02-18 23:28:06 -05:00
```
chore: update descriptions
2023-11-23 22:14:29 -05:00
$ ./gradlew assembleDebug
initial commit
2023-05-24 01:33:20 -04:00
```
docs: update readme
2024-06-01 03:00:41 -04:00
## Contributing
Any contributions in the form of feedback, issues, code, or translations are welcome and much
appreciated!
Please read
the [code of conduct](https://github.com/zaneschepke/wgtunnel?tab=coc-ov-file#contributor-code-of-conduct)
before contributing.