Skip to content

Commit

Permalink
docs: update features page
Browse files Browse the repository at this point in the history
Add README.md for context.
  • Loading branch information
zaneschepke committed Jan 14, 2024
1 parent 3d2eb9e commit 1dc4519
Show file tree
Hide file tree
Showing 7 changed files with 78 additions and 21 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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).
3 changes: 2 additions & 1 deletion Writerside/cfg/glossary.xml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE terms SYSTEM "https://resources.jetbrains.com/writerside/1.0/glossary.dtd">
<terms>
<term name="primary tunnel">This is the designated default tunnel config that is denoted by a star in the app.</term>
<term name="primary_tunnel">This is the designated default tunnel config denoted by a star in the app.</term>
<term name="wakelock">The ability to keep the CPU of the Android device running even after the phone has been put to sleep.</term>
</terms>
15 changes: 14 additions & 1 deletion Writerside/topics/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
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.
58 changes: 49 additions & 9 deletions Writerside/topics/Features.md
Original file line number Diff line number Diff line change
@@ -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.

<note>
<p>
Some features are only available on mobile and will be marked
<a href="FAQ.md#tv-features-faq"><emphasis>(Mobile only)</emphasis></a>.
</p>
</note>

## 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 <a href="FAQ.md#tv-features-faq"><emphasis>(Mobile only)</emphasis></a>
- 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
<a href="FAQ.md#tv-features-faq"><emphasis>(Mobile only)</emphasis></a>

Coming soon!

## Exporting tunnel configs {id="export-feature"}

<a href="FAQ.md#tv-features-faq"><emphasis>(Mobile only)</emphasis></a>

%product% offers the ability to export all of your tunnel configurations to a zip folder.

1. Navigate to the <emphasis>Settings</emphasis> screen.
2. Click `Export configs` near the bottom of the screen.
3. Complete the biometrics prompt.
4. All configs are now saved to the <emphasis>Downloads</emphasis> folder on your device in a zip folder called `wg-export_<timestamp>.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.

<note>
<p>
It can sometimes take up to a few minutes after boot for the service be started by Android.
</p>
</note>

## 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

<seealso>
<category ref="wrs">
<a href="https://github.com/zaneschepke/wgtunnel">Github project</a>
<a href="https://github.com/zaneschepke/wgtunnel/releases">Changelog</a>
</category>
</seealso>
3 changes: 1 addition & 2 deletions Writerside/topics/Integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <tooltip term="primary tunnel">primary tunnel</tooltip>.
controlling the <tooltip term="primary_tunnel">primary tunnel</tooltip>.

<procedure title="Using shortcuts" id="inject-a-procedure">
<step>
Expand All @@ -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.
6 changes: 4 additions & 2 deletions Writerside/topics/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ These factors sparked the creation of <a href="https://github.com/zaneschepke/wg

A definition list or a glossary:

primary tunnel
: This is the designated default tunnel config (denoted by a star in the app) that is toggled by features like auto-tunneling, app shortcuts, always-on VPN, and the quicktile setting.
- <tooltip term="primary_tunnel">Primary tunnel</tooltip>
- <tooltip term="wakelock">Wakelock</tooltip>



8 changes: 2 additions & 6 deletions Writerside/topics/PrivacyPolicy.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
------------------------
Expand All @@ -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
Effective as of May 24, 2023

0 comments on commit 1dc4519

Please sign in to comment.