Enhance VPN configuration guide with detailed instructions

2024-12-26 10:57:27 -03:00 · 2024-12-26 10:57:27 -03:00 · 72879ceb81
commit 72879ceb81
parent fe66243de5
1 changed files with 94 additions and 53 deletions
--- a/content/advanced/vpn.md
+++ b/content/advanced/vpn.md
@ -1,17 +1,29 @@
 ---
-title: "VPN"
+title: "VPN Configuration"
 date: 2023-01-15T21:16:29-03:00
 draft: false
 weight: 2
-summary: Advanced configuration for the VPN, supported VPN lists and manual configuration.
+summary: Everything you need to know about configuring and using a VPN with YAMS
 ---

-Remember: **You should always use a VPN when downloading torrents!**.
+# Keeping Your Downloads Private 🔒

-YAMS uses [gluetun](https://github.com/qdm12/gluetun) for VPN.
+Let's talk about VPNs! While they might seem like an optional extra, **you should always use a VPN when downloading torrents**. It's not just about privacy - it's about keeping you safe and sound on the internet! 

-## Official supported VPNs
+YAMS uses [gluetun](https://github.com/qdm12/gluetun) to manage VPN connections. It's like a super-smart traffic controller for your downloads! 🚦

+## Supported VPN Providers 🌐
+
+YAMS works with tons of VPN providers! Here's the full list, with direct links to their setup guides:
+
+### Popular Choices 🌟
+- [ProtonVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/protonvpn.md) (Recommended! Easy to set up and great privacy)
+- [Mullvad](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md)
+- [NordVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/nordvpn.md)
+- [Private Internet Access](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/private-internet-access.md)
+- [Surfshark](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/surfshark.md)
+
+### Full Provider List 📋
 - [AirVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/airvpn.md)
 - [Cyberghost](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/cyberghost.md)
 - [ExpressVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/expressvpn.md)
@ -19,16 +31,11 @@ YAMS uses [gluetun](https://github.com/qdm12/gluetun) for VPN.
 - [Hidemyass](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/hidemyass.md)
 - [IPVanish](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/ipvanish.md)
 - [IVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/ivpn.md)
- [Mullvad](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/mullvad.md)
- [NordVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/nordvpn.md)
- [Perfect privacy](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/perfect-privacy.md)
+- [Perfect Privacy](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/perfect-privacy.md)
 - [Privado](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/privado.md)
- [Private internet access](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/private-internet-access.md)
 - [PrivateVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/privatevpn.md)
- [ProtonVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/protonvpn.md) **(Recommended!)**
 - [PureVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/purevpn.md)
 - [SlickVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/slickvpn.md)
- [Surfshark](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/surfshark.md)
 - [Torguard](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/torguard.md)
 - [VPN Secure](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/vpn-secure.md)
 - [VPN Unlimited](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/vpn-unlimited.md)
@ -36,77 +43,76 @@ YAMS uses [gluetun](https://github.com/qdm12/gluetun) for VPN.
 - [WeVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/wevpn.md)
 - [Windscribe](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/windscribe.md)

-You can also set up a [custom VPN provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md), but **this is not officially supported for YAMS. You are on your own here.**
+Want to use a different VPN? You can set up a [custom VPN provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md), but keep in mind this isn't officially supported by YAMS. You'll be in DIY territory! 🛠️

-## Manual configuration
+## Manual Configuration 🔧

-To manually configure your VPN, you have to edit your `docker-compose.yaml` and `.env` files.
+Let's walk through setting up your VPN manually. For this guide, I'll assume your YAMS is installed in `/opt/yams` - adjust the paths if you installed it somewhere else!

-First, stop `YAMS`:
+### Step 1: Stop YAMS
 ```bash
-$ yams stop
+yams stop
 ```

-Now, open your `.env` file. For this tutorial, I'm assuming the install location is `/opt/yams`. Also, you don't have to use `vim`, you can use `nano` or any other editor.
-
+### Step 2: Configure Your VPN Settings
+Open your `.env` file:
 ```bash
-$ vim /opt/yams/.env
+nano /opt/yams/.env
 ```

-On the file, make the following changes:
+Find the VPN section and update it:
 ```bash
 # VPN configuration
 VPN_ENABLED=y
-VPN_SERVICE=protonvpn # -> Your VPN service. Check the list here: https://yams.media/advanced/vpn/#official-supported-vpns
-VPN_USER=your-user # -> Your VPN user
-VPN_PASSWORD=your-password # -> Your VPN password
+VPN_SERVICE=protonvpn     # Your VPN service from the list above
+VPN_USER=your-username    # Your VPN username
+VPN_PASSWORD=your-pass    # Your VPN password
 ```

-Then, open your `docker-compose.yaml` file. For this tutorial, I'm assuming the install location is `/opt/yams`. Also, you don't have to use `vim`, you can use `nano` or any other editor.
-
+### Step 3: Update Docker Compose
+Open `docker-compose.yaml`:
 ```bash
-$ vim /opt/yams/docker-compose.yaml
+nano /opt/yams/docker-compose.yaml
 ```

-On the file, find the `qbitorrent` config and make the following changes:
-
+Find the qBittorrent section and make these changes:
 ```yaml
-...
-    # ports: # qbittorrent -> Comment this line
-    #  - 8081:8081 # qbittorrent -> Comment this line
-    network_mode: "service:gluetun" -> Uncomment this line
+  qbittorrent:
+    # ports:     # Comment out these lines
+    #  - 8081:8081
+    network_mode: "service:gluetun"  # Uncomment this line
 ```

-Now, find the `sabnzbd` config and make the following changes:
+Find the SABnzbd section and make similar changes:
 ```yaml
-...
-    # ports: # sabnzbd -> Comment this line 
-    # - 8080:8080 # sabnzbd -> Comment this line 
-    network_mode: "service:gluetun" -> Uncomment this line
-...
+  sabnzbd:
+    # ports:     # Comment out these lines
+    # - 8080:8080
+    network_mode: "service:gluetun"  # Uncomment this line
 ```

-Then, at the bottom, find the `gluetun` config and make the following changes:
-
+At the bottom, find the gluetun section and uncomment these ports:
 ```yaml
-...
-      - 8080:8080/tcp # gluetun -> Uncomment this line
-      - 8081:8081/tcp # gluetun -> Uncomment this line
+  gluetun:
+    ports:
+      - 8080:8080/tcp  # Uncomment this line
+      - 8081:8081/tcp  # Uncomment this line
 ```

-Now, restart `YAMS`:
-
+### Step 4: Restart and Test
 ```bash
-$ yams restart
+yams restart
 ```

-Finally, check that your VPN is running correctly:
-
+### Step 5: Verify Everything Works
 ```bash
-$ yams check-vpn
+yams check-vpn
+```

+You should see something like:
+```bash
 Getting your qBittorrent IP...
-<your_qbittorrent_ip>
+<qbittorrent_ip>
 Your country in qBittorrent is Brazil

 Getting your IP...
@ -116,8 +122,43 @@ Your local IP country is North Korea
 Your IPs are different. qBittorrent is working as expected! ✅
 ```

-If it's not running correctly, check every setting and make sure they are all correct.
+If you get an error, double-check all your settings and make sure they're correct!

-## Double-check your torrent client IP address
+## Pro Tips 🎯

-Go [here](/advanced/torrenting/#double-checking-your-torrent-client-ip-address).
+1. **Regular Checks**: Run `yams check-vpn` periodically to make sure your VPN is working correctly
+2. **Kill Switch**: YAMS automatically includes a kill switch - if the VPN goes down, your downloads stop too!
+3. **Speed Matters**: Choose a VPN server that's relatively close to you for better download speeds
+4. **Port Problems**: If you can't access qBittorrent after setting up the VPN, check the troubleshooting section below
+
+## Troubleshooting 🔧
+
+### Common Issues:
+
+1. **Can't access qBittorrent:**
+   - Check gluetun logs: `docker logs gluetun`
+   - Verify your VPN credentials
+   - Make sure ports are configured correctly
+
+2. **VPN keeps disconnecting:**
+   - Try a different VPN server
+   - Check your internet connection
+   - Review the gluetun logs for errors
+
+3. **Slow speeds:**
+   - Try a server closer to your location
+   - Check if your VPN provider throttles P2P traffic
+   - Some providers have specialized servers for torrenting - try those!
+
+## Need Extra Security? 🛡️
+
+Want to double-check that your torrent client is really using the VPN? Head over to [Double-checking your torrent client IP address](/advanced/torrenting/#double-checking-your-torrent-client-ip-address) for a detailed guide!
+
+## Still Need Help? 🆘
+
+If you're stuck:
+1. Check our [Common Issues](/faqs/common-errors/#gluetun-does-not-connect) page
+2. Visit the [YAMS Forum](https://forum.yams.media)
+3. Join our [Discord](https://discord.gg/Gwae3tNMST) or [Matrix](https://matrix.to/#/#yams-space:rogs.me) chat
+
+Remember: A working VPN is crucial for safe downloading. Take the time to set it up right, and you'll be good to go! 🚀