Skip to content
This repository was archived by the owner on Apr 13, 2025. It is now read-only.

Commit d4a048d

Browse files
committed
docs: add getting started, update features
1 parent 73cab13 commit d4a048d

File tree

5 files changed

+78
-9
lines changed

5 files changed

+78
-9
lines changed

Writerside/cfg/glossary.xml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@
33
<terms>
44
<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>
55
<term name="wakelock">The ability to keep the CPU of the Android device running even after the phone has been put to sleep.</term>
6+
<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>
7+
<term name="vpn_client">An application used to connect to VPN servers from a specific device and provide device level capabilities.</term>
68
</terms>

Writerside/hi.tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
start-page="Overview.md">
88

99
<toc-element topic="Overview.md"/>
10+
<toc-element topic="Getting-started.md"/>
1011
<toc-element topic="Features.md"/>
1112
<toc-element topic="Integrations.md"/>
1213
<toc-element topic="FAQ.md"/>

Writerside/topics/Features.md

Lines changed: 45 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,12 @@ After clicking the floating action button on the main screen, the following opti
2525
## Auto-tunneling
2626

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

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

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

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

57-
## Auto-tunneling override
57+
### Auto-tunneling to a specific tunnel by wifi name and/or mobile data
58+
59+
A common scenario is when a user wants to use a specific tunnel config when they are connected to certain networks.
60+
61+
> For example,
62+
a user might want to connect to their home VPN server when they are away from home
63+
and then want to connect to their VPN provider's server while at home.
64+
65+
%product% now allows users to configure each tunnel to be used on specific Wi-Fi networks and/or mobile data.
66+
Tunnels configured with these settings will be prioritized over the primary tunnel if the app detects a match.
67+
68+
To configure:
69+
- Long press on the tunnel config you would like to configure from the main screen
70+
- Click the gear icon
71+
- 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.
72+
73+
%product% auto-tunneling will now prioritize using this specific tunnel if it detects a matching network scenario.
74+
75+
76+
### Auto-tunneling override
5877

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

108-
## Battery saver (beta)
127+
## Restart on ping fail (beta)
109128

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

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

135+
## Enable app lock
136+
137+
This feature allows the user to set an app-specific pin when launching WG Tunnel.
138+
139+
The primary use case for this feature is
140+
to serve as a parental control mechanism to prevent phone users from being able to disable auto-tunneling.
141+
142+
To config:
143+
- Navigate to app settings
144+
- Toggle "Enable app lock"
145+
- Set your pin
146+
147+
<warning>
148+
<p>
149+
Do not forget your pin as there is not a reset feature in the app.
150+
If you forget your pin, you will have to uninstall and reinstall the app.
151+
</p>
152+
</warning>
115153

116154
## Tunnel statistics
117155

Writerside/topics/Getting-started.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# Getting started
2+
3+
It is important to understand that %product% is a <tooltip term="vpn_client">VPN client</tooltip> application and not a
4+
<tooltip term="vpn_service">VPN service</tooltip> provider. In short, this means that this application does not provide
5+
a VPN server for users to connect to by default. It is expected that the user either is hosting their own VPN server, or
6+
they are paying a <tooltip term="vpn_service">VPN service</tooltip> provider.
7+
8+
If you are new to using VPNs and do not yet have a <tooltip term="vpn_service">VPN service</tooltip> provider or VPN server,
9+
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>.
10+
11+
<warning>
12+
<p>
13+
I do not personally use <a href="https://protonvpn.com/">ProtonVPN</a>, nor am I advocating for using their services.
14+
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
15+
easy method for exporting <a href="https://www.wireguard.com/">WireGuard</a> configurations.
16+
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
17+
to your sensitive internet traffic data.
18+
</p>
19+
</warning>
20+
21+
### Steps for getting a WireGuard config:
22+
- Create a new account on <a href="https://protonvpn.com/">ProtonVPN</a>'s site.
23+
- 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.
24+
- On the main screen of %product%, click the floating action button and select "Add from file or zip".
25+
- Navigate to your newly downloaded <a href="https://www.wireguard.com/">WireGuard</a> configuration file and select it.
26+
27+
You are now ready to start using %product% as your Android VPN client.
28+

Writerside/topics/Overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,10 @@ These factors sparked the creation of <a href="https://github.com/zaneschepke/wg
1313

1414
## Glossary
1515

16-
A definition list or a glossary:
17-
1816
- <tooltip term="primary_tunnel">Primary tunnel</tooltip>
1917
- <tooltip term="wakelock">Wakelock</tooltip>
18+
- <tooltip term="vpn_service">VPN service</tooltip>
19+
- <tooltip term="vpn_client">VPN client</tooltip>
2020

2121
<seealso>
2222
<category ref="wrs">

0 commit comments

Comments
 (0)