diff --git a/Writerside/cfg/glossary.xml b/Writerside/cfg/glossary.xml index 986c51a..58bcdd1 100644 --- a/Writerside/cfg/glossary.xml +++ b/Writerside/cfg/glossary.xml @@ -3,4 +3,6 @@ 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. The ability to keep the CPU of the Android device running even after the phone has been put to sleep. + A VPN service is an entity that maintains and manages VPN servers and provides connection access to users/customers (usually for a price). + An application used to connect to VPN servers from a specific device and provide device level capabilities. \ No newline at end of file diff --git a/Writerside/hi.tree b/Writerside/hi.tree index df76b46..066e219 100644 --- a/Writerside/hi.tree +++ b/Writerside/hi.tree @@ -7,6 +7,7 @@ start-page="Overview.md"> + diff --git a/Writerside/topics/Features.md b/Writerside/topics/Features.md index 886329b..ce048cd 100644 --- a/Writerside/topics/Features.md +++ b/Writerside/topics/Features.md @@ -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 primary tunnel. Setting a primary tunnel can be accomplished by doing a long-press on the desired tunnel config on the main screen -and clicking the star icon. +and clicking the gear icon.

@@ -54,7 +54,26 @@ There are three auto-tunneling modes that can be used in combination or individu - Common use case: 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. @@ -105,13 +124,32 @@ This feature will automatically restart the auto-tunneling service on boot if th

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

+ 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. +

+
## Tunnel statistics diff --git a/Writerside/topics/Getting-started.md b/Writerside/topics/Getting-started.md new file mode 100644 index 0000000..3f05045 --- /dev/null +++ b/Writerside/topics/Getting-started.md @@ -0,0 +1,28 @@ +# Getting started + +It is important to understand that %product% is a VPN client application and not a +VPN service 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 VPN service provider. + +If you are new to using VPNs and do not yet have a VPN service provider or VPN server, +one of the easiest ways to get started is with a free VPN service provider like ProtonVPN. + + +

+ I do not personally use ProtonVPN, 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 WireGuard configurations. + It is highly recommended 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. +

+
+ +### Steps for getting a WireGuard config: +- Create a new account on ProtonVPN's site. +- Follow their tutorial on how to export a WireGuard 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 WireGuard configuration file and select it. + +You are now ready to start using %product% as your Android VPN client. + diff --git a/Writerside/topics/Overview.md b/Writerside/topics/Overview.md index 7255cf3..38f12d7 100644 --- a/Writerside/topics/Overview.md +++ b/Writerside/topics/Overview.md @@ -13,10 +13,10 @@ These factors sparked the creation of Primary tunnel - Wakelock +- VPN service +- VPN client