- Updated the weight values for several documentation pages.
- Ensured consistent ordering and prioritization of advanced guides.
- Improved overall documentation structure.

2025-03-29 17:19:20 -03:00

6.4 KiB

Raw Blame History

title, date, draft, weight, summary

title	date	draft	weight	summary
VPN	2023-01-15T21:16:29-03:00	false	30	Everything you need to know about configuring and using a VPN with YAMS

Keeping Your Downloads Private 🔒

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!

YAMS uses 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 (Recommended! Easy to set up and great privacy)
Mullvad
NordVPN
Private Internet Access
Surfshark

Full Provider List 📋

Want to use a different VPN? You can set up a custom VPN provider, but keep in mind this isn't officially supported by YAMS. You'll be in DIY territory! 🛠️

Manual Configuration 🔧

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!

Step 1: Stop YAMS

yams stop

Step 2: Configure Your VPN Settings

Open your .env file:

nano /opt/yams/.env

Find the VPN section and update it:

# VPN configuration
VPN_ENABLED=y
VPN_SERVICE=protonvpn     # Your VPN service from the list above
VPN_USER=your-username    # Your VPN username
VPN_PASSWORD=your-pass    # Your VPN password

Step 3: Update Docker Compose

Open docker-compose.yaml:

nano /opt/yams/docker-compose.yaml

Find the qBittorrent section and make these changes:

  qbittorrent:
    # ports:     # Comment out these lines
    #  - 8081:8081
    network_mode: "service:gluetun"  # Uncomment this line

Find the SABnzbd section and make similar changes:

  sabnzbd:
    # ports:     # Comment out these lines
    # - 8080:8080
    network_mode: "service:gluetun"  # Uncomment this line

At the bottom, find the gluetun section and uncomment these ports:

  gluetun:
    ports:
      - 8080:8080/tcp  # Uncomment this line
      - 8081:8081/tcp  # Uncomment this line

Step 4: Restart and Test

yams restart

Step 5: Verify Everything Works

yams check-vpn

You should see something like:

Getting your qBittorrent IP...
<qbittorrent_ip>
Your country in qBittorrent is Brazil

Getting your IP...
<your_local_ip>
Your local IP country is North Korea

Your IPs are different. qBittorrent is working as expected! ✅

If you get an error, double-check all your settings and make sure they're correct!

Pro Tips 🎯

Regular Checks: Run yams check-vpn periodically to make sure your VPN is working correctly
Kill Switch: YAMS automatically includes a kill switch - if the VPN goes down, your downloads stop too!
Speed Matters: Choose a VPN server that's relatively close to you for better download speeds
Port Problems: If you can't access qBittorrent after setting up the VPN, check the troubleshooting section below

Troubleshooting 🔧

Common Issues:

Can't access qBittorrent:
- Check gluetun logs: docker logs gluetun
- Verify your VPN credentials
- Make sure ports are configured correctly
VPN keeps disconnecting:
- Try a different VPN server
- Check your internet connection
- Review the gluetun logs for errors
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 for a detailed guide!

Still Need Help? 🆘

If you're stuck:

Check our Common Issues page
Visit the YAMS Forum
Join our Discord or Matrix 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! 🚀

6.4 KiB Raw Blame History