Skip to content

Commit

Permalink
docs: add getting started, update features
Browse files Browse the repository at this point in the history
  • Loading branch information
zaneschepke committed May 4, 2024
1 parent 73cab13 commit d4a048d
Show file tree
Hide file tree
Showing 5 changed files with 78 additions and 9 deletions.
2 changes: 2 additions & 0 deletions Writerside/cfg/glossary.xml
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@
<terms>
<term name="primary_tunnel">This is the designated default tunnel config denoted by a star in the app. It is the config that will be used by the quick settings tile, static shortcuts, auto-tunneling, and Always-On VPN by default.</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>
<term name="vpn_service">A VPN service is an entity that maintains and manages VPN servers and provides connection access to users/customers (usually for a price).</term>
<term name="vpn_client">An application used to connect to VPN servers from a specific device and provide device level capabilities.</term>
</terms>
1 change: 1 addition & 0 deletions Writerside/hi.tree
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
start-page="Overview.md">

<toc-element topic="Overview.md"/>
<toc-element topic="Getting-started.md"/>
<toc-element topic="Features.md"/>
<toc-element topic="Integrations.md"/>
<toc-element topic="FAQ.md"/>
Expand Down
52 changes: 45 additions & 7 deletions Writerside/topics/Features.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,12 +25,12 @@ After clicking the floating action button on the main screen, the following opti
## Auto-tunneling

Auto-tunneling is the core feature of the application.
It allows users to automate under which network circumstances a tunnel will activate.
It allows users to automate which tunnel will be active under certain network circumstances.

A core concept when using auto-tunneling is setting a <tooltip term="primary_tunnel">primary tunnel</tooltip>.

Setting a primary tunnel can be accomplished by doing a long-press on the desired tunnel config on the main screen
and clicking the <emphasis>star icon</emphasis>.
and clicking the <emphasis>gear icon</emphasis>.

<note>
<p>
Expand All @@ -54,7 +54,26 @@ There are three auto-tunneling modes that can be used in combination or individu
- <emphasis>Common use case:</emphasis> Disable the tunnel on my home (trusted) network,
but enable it when I connect to any public Wi-Fi network.

## Auto-tunneling override
### Auto-tunneling to a specific tunnel by wifi name and/or mobile data

A common scenario is when a user wants to use a specific tunnel config when they are connected to certain networks.

> For example,
a user might want to connect to their home VPN server when they are away from home
and then want to connect to their VPN provider's server while at home.

%product% now allows users to configure each tunnel to be used on specific Wi-Fi networks and/or mobile data.
Tunnels configured with these settings will be prioritized over the primary tunnel if the app detects a match.

To configure:
- Long press on the tunnel config you would like to configure from the main screen
- Click the gear icon
- Add a Wi-Fi name where you would like to prioritize using this tunnel or turn on mobile data if this is your mobile data specific tunnel.

%product% auto-tunneling will now prioritize using this specific tunnel if it detects a matching network scenario.


### Auto-tunneling override

Auto-tunnel override is a feature of %product% that allows users to temporarily
pause (override) [auto-tunneling](#auto-tunneling) to toggle a tunnel.
Expand Down Expand Up @@ -105,13 +124,32 @@ This feature will automatically restart the auto-tunneling service on boot if th
</p>
</note>

## Battery saver (beta)
## Restart on ping fail (beta)

This feature shortens the wakelock timer for %product% to prevent it from draining the battery.
This feature attempts to restart the tunnel if it is failing to ping your server.
This feature is still in beta and will likely change in the future.

- Timer with battery saver: 10-minutes
- Timer without battery saver: 30-minutes
- Pings vpn server address on an interval: 1-minute(s)
- Cooldown after a failed ping/restart is triggered: 60-minute(s)

## Enable app lock

This feature allows the user to set an app-specific pin when launching WG Tunnel.

The primary use case for this feature is
to serve as a parental control mechanism to prevent phone users from being able to disable auto-tunneling.

To config:
- Navigate to app settings
- Toggle "Enable app lock"
- Set your pin

<warning>
<p>
Do not forget your pin as there is not a reset feature in the app.
If you forget your pin, you will have to uninstall and reinstall the app.
</p>
</warning>

## Tunnel statistics

Expand Down
28 changes: 28 additions & 0 deletions Writerside/topics/Getting-started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Getting started

It is important to understand that %product% is a <tooltip term="vpn_client">VPN client</tooltip> application and not a
<tooltip term="vpn_service">VPN service</tooltip> provider. In short, this means that this application does not provide
a VPN server for users to connect to by default. It is expected that the user either is hosting their own VPN server, or
they are paying a <tooltip term="vpn_service">VPN service</tooltip> provider.

If you are new to using VPNs and do not yet have a <tooltip term="vpn_service">VPN service</tooltip> provider or VPN server,
one of the easiest ways to get started is with a free <tooltip term="vpn_service">VPN service</tooltip> provider like <a href="https://protonvpn.com/">ProtonVPN</a>.

<warning>
<p>
I do not personally use <a href="https://protonvpn.com/">ProtonVPN</a>, nor am I advocating for using their services.
The reason I am referencing this company in these docs is because they happen to be a well-known VPN provider with a free tier and an
easy method for exporting <a href="https://www.wireguard.com/">WireGuard</a> configurations.
It is <format style="bold">highly recommended</format> you do your own research on which VPN provider you want to use as you are trusting them with access to
to your sensitive internet traffic data.
</p>
</warning>

### Steps for getting a WireGuard config:
- Create a new account on <a href="https://protonvpn.com/">ProtonVPN</a>'s site.
- Follow their <a href="https://protonvpn.com/support/wireguard-configurations/">tutorial</a> on how to export a <a href="https://www.wireguard.com/">WireGuard</a> configuration file.
- On the main screen of %product%, click the floating action button and select "Add from file or zip".
- Navigate to your newly downloaded <a href="https://www.wireguard.com/">WireGuard</a> configuration file and select it.

You are now ready to start using %product% as your Android VPN client.

4 changes: 2 additions & 2 deletions Writerside/topics/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,10 @@ These factors sparked the creation of <a href="https://github.com/zaneschepke/wg

## Glossary

A definition list or a glossary:

- <tooltip term="primary_tunnel">Primary tunnel</tooltip>
- <tooltip term="wakelock">Wakelock</tooltip>
- <tooltip term="vpn_service">VPN service</tooltip>
- <tooltip term="vpn_client">VPN client</tooltip>

<seealso>
<category ref="wrs">
Expand Down

0 comments on commit d4a048d

Please sign in to comment.