diff --git a/README.md b/README.md new file mode 100644 index 0000000..d668712 --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# WG Tunnel docs + +A simple [Writerside](https://www.jetbrains.com/writerside/) project for documenting +the features and behaviors for [WG Tunnel](https://github.com/zaneschepke/wgtunnel). + +The live webpage can be viewed [here](https://zaneschepke.com/wgtunnel-docs/overview.html). \ No newline at end of file diff --git a/Writerside/cfg/glossary.xml b/Writerside/cfg/glossary.xml index 548b07d..f7c4dda 100644 --- a/Writerside/cfg/glossary.xml +++ b/Writerside/cfg/glossary.xml @@ -1,5 +1,6 @@ - This is the designated default tunnel config that is denoted by a star in the app. + This is the designated default tunnel config denoted by a star in the app. + The ability to keep the CPU of the Android device running even after the phone has been put to sleep. \ No newline at end of file diff --git a/Writerside/topics/FAQ.md b/Writerside/topics/FAQ.md index e9ab314..74c2841 100644 --- a/Writerside/topics/FAQ.md +++ b/Writerside/topics/FAQ.md @@ -10,4 +10,17 @@ for AndroidTV. This can result is a somewhat clunky user experience. ### How do I add a tunnel? To add a tunnel, you need either a WireGuard server or a VPN Provider that allows you to export -tunnel configs for third party apps. This will be in the form of a `.conf` file or a QR code. \ No newline at end of file +tunnel configs for third party apps. This will be in the form of a `.conf` file or a QR code. + +### Does %product% work with Android Auto? + +Yes, %product% works with Android Auto, but this requires some configuration. +You need to disable tunneling for the Android Auto app by leveraging the app's split tunneling feature. +For more information on how to do this, see the [Split Tunneling](Features.md#split) section. This will effectively disable Android Auto app traffic from passing through the tunnel, +while still tunneling the app traffic for all of your other apps. + + +### Why are some feature not available for AndroidTV? {id="tv-features-faq"} + +Unfortunately, AndroidTV does not have all the same API and security features as Android mobile. +For this reason, some features are disabled for AndroidTV. \ No newline at end of file diff --git a/Writerside/topics/Features.md b/Writerside/topics/Features.md index d0cc56c..c86ee0f 100644 --- a/Writerside/topics/Features.md +++ b/Writerside/topics/Features.md @@ -1,37 +1,77 @@ # Features -This sections details all the app's existing features and behaviors. +This section details all the app's existing features and behaviors. + + +

+ Some features are only available on mobile and will be marked +(Mobile only). +

+ ## Adding tunnel configs -There are multiple ways tunnel configs can be added to the app. +There are multiple ways tunnel configs can be added to the app. + +After clicking the floating action button on the main screen, the following options are available: + +1. Upload a `.conf` file +2. Upload a zip containing `.conf` files (like an export from %product% or the official app) +3. Scan a QR code (Mobile only) + - This option will upload the tunnel with a randomly generated name. +4. Create one from scratch ## Auto-tunneling Coming soon! -## Split tunneling {collapsible="true"} +## Split tunneling {collapsible="true"} {id="split"} -Coming soon! +Split tunneling is a feature that allows a user to route only selected app's traffic through the tunnel. +Currently, this is configured on a per-tunnel basis. -## Always-on VPN +A common use-case could be +that a user wants apps that only function in another country +to be tunneled to a VPN server in that country while all other apps use the normal network. -Coming soon! +## Always-on VPN {id="always-on-feature"} -## Exporting tunnel configs +(Mobile only) Coming soon! +## Exporting tunnel configs {id="export-feature"} + +(Mobile only) + +%product% offers the ability to export all of your tunnel configurations to a zip folder. + +1. Navigate to the Settings screen. +2. Click `Export configs` near the bottom of the screen. +3. Complete the biometrics prompt. +4. All configs are now saved to the Downloads folder on your device in a zip folder called `wg-export_.zip`. + + ## Auto restart on boot -Coming soon! +Auto start on boot is automatically enabled when a user enables auto-tunneling. +This feature will automatically restart the auto-tunneling service on boot if the phone has been shutdown or rebooted. + + +

+ It can sometimes take up to a few minutes after boot for the service be started by Android. +

+ ## Battery saver (beta) -Coming soon! +This feature shortens the wakelock timer for %product% to prevent it from draining the battery. +- Timer with battery saver: 10-minutes +- Timber without battery saver: 30-minutes Github project + Changelog diff --git a/Writerside/topics/Integrations.md b/Writerside/topics/Integrations.md index 469c2dc..576547c 100644 --- a/Writerside/topics/Integrations.md +++ b/Writerside/topics/Integrations.md @@ -5,7 +5,7 @@ This sections details the integration options available for %product%. ## App Shortcuts %product% supports two [static shortcuts](https://developer.android.com/develop/ui/views/launch/shortcuts/creating-shortcuts#static) for -controlling the primary tunnel. +controlling the primary tunnel. @@ -22,7 +22,6 @@ These shortcut buttons can also be dragged to a screen for easier access. Additionally, many automation apps (like [Macrodroid](https://www.macrodroid.com/)) are able to integrate with and activate these shortcuts. - ## Intents Coming soon! For now, reference this issue comment [here](https://github.com/zaneschepke/wgtunnel/issues/44#issuecomment-1773890867) for intent configuration details. diff --git a/Writerside/topics/Overview.md b/Writerside/topics/Overview.md index fa9fc86..a1de890 100644 --- a/Writerside/topics/Overview.md +++ b/Writerside/topics/Overview.md @@ -15,6 +15,8 @@ These factors sparked the creation of Primary tunnel +- Wakelock + + diff --git a/Writerside/topics/PrivacyPolicy.md b/Writerside/topics/PrivacyPolicy.md index 5a948aa..2bfd71f 100644 --- a/Writerside/topics/PrivacyPolicy.md +++ b/Writerside/topics/PrivacyPolicy.md @@ -1,8 +1,5 @@ # Privacy Policy -Privacy Policy -============== - WG Tunnel provides an alternative Android client app for network tunnels using the WireGuard Protocol. Information you provide @@ -17,7 +14,7 @@ Background Location This application does collect location information (specifically Wi-Fi ssid name) in the background for the auto tunnel feature. This information is not stored or transmitted but is simple collected -by the app to determine whether or not to turn on the VPN. +by the app to determine whether to turn on the VPN. Updates to this document ------------------------ @@ -32,5 +29,4 @@ If you have questions about this Privacy Policy, please contact me zanecschepke@gmail.com or Discord (invite link on this repository). -Effective as of May 24, 2023 -Updated May 24, 2023 \ No newline at end of file +Effective as of May 24, 2023 \ No newline at end of file