From b3779fef6915871bd2d118fd406407d039a9a98b Mon Sep 17 00:00:00 2001
From: bosskie <80441763+bosskie@users.noreply.github.com>
Date: Wed, 18 Sep 2024 21:28:49 +0530
Subject: [PATCH] Updated qbittorrentvpn.md for ProtonVPN (Wireguard) (#299)

---
 docs/sandbox/apps/qbittorrentvpn.md | 64 +++++++++++++++++++++++------
 1 file changed, 52 insertions(+), 12 deletions(-)

diff --git a/docs/sandbox/apps/qbittorrentvpn.md b/docs/sandbox/apps/qbittorrentvpn.md
index eebc3a58c..4c3c6a05d 100644
--- a/docs/sandbox/apps/qbittorrentvpn.md
+++ b/docs/sandbox/apps/qbittorrentvpn.md
@@ -10,23 +10,63 @@
 
 ### 1. Installation
 
-In `/opt/sandbox/settings.yml`, adjust the following:
+=== "PIA VPN"
 
-```
-qbittorrentvpn:
-  vpn_pass: your_vpn_password
-  vpn_prov: pia
-  vpn_user: your_vpn_username
-  vpn_client: wireguard
-```
+    In `/opt/sandbox/settings.yml`, adjust the following:
+    
+    ```
+    qbittorrentvpn:
+      vpn_pass: your_vpn_password
+      vpn_prov: pia
+      vpn_user: your_vpn_username
+      vpn_client: wireguard
+    ```
 
-As described in the github readme linked above, then run the role:
+    As described in the github readme linked above, then run the role:
 
-``` shell
+    ``` shell
 
-sb install sandbox-qbittorrentvpn
+    sb install sandbox-qbittorrentvpn
 
-```
+    ```
+
+=== "Proton VPN (Wireguard)"
+
+    Step 01 - Please login in to [ProtonVPN-Account](https://account.protonvpn.com/account)
+    Step 02 - Under "OpenVPN / IKEv2 username" section —> Copy this OpenVPN / IKEv2 username [Yeah, somehow this username is required for Wireguard]
+    Step 03 - Go to [ProtonVPN-Downloads](https://account.protonvpn.com/downloads)
+    Step 04 - Scroll down to "WireGuard configuration" - Please fill/select your desired settings for the configuration.
+    Step 05 - Under "3. Select VPN options" —> Turn on "NAT-PMP (Port Forwarding)" —> Now download the config file and rename it to `wg0.conf`
+    
+    Now, In `/opt/sandbox/settings.yml`, adjust the following:
+    
+    ```
+    qbittorrentvpn:
+      vpn_pass: "protonvpn-account-password"
+      vpn_prov: "protonvpn"
+      vpn_user: "<OpenVPN / IKEv2 username>+pmp" #which we've copied from Step 02
+      vpn_client: "wireguard"
+    ```
+    Example for reference
+    ```
+    qbittorrentvpn:
+      vpn_pass: "xdfasdicmb"
+      vpn_prov: "protonvpn"
+      vpn_user: "zuqWGtyy7SMGQM8C+pmp"
+      vpn_client: "wireguard"
+    ```
+    As described in the github readme linked above, then run the role:
+
+    ``` shell
+
+    sb install sandbox-qbittorrentvpn
+
+    ```
+    While the above command runs, go to this directory `/opt/qbittorrentvpn/wireguard` (Use FTP file manager like WinSCP)
+    if you don't see this directory wait for few seconds, while the previous command creates this.
+
+    Now copy & paste your `wg0.conf' file (Refer Step 05) in this directory & Wait for the command line to complete.
+    If everything went well, you should see `Playbook /opt/sandbox/sandbox.yml executed successfully.`
 
 ### 2. URL