-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
7 changed files
with
78 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters