yams.media/content/advanced/vpn.md

title, date, draft, weight, summary

title	date	draft	weight	summary
VPN	2023-01-15T21:16:29-03:00	false	2	Advanced configuration for the VPN, supported VPN lists and manual configuration.

Remember: You should always use a VPN when downloading torrents!.

YAMS uses gluetun for VPN.

Official supported VPNs

• AirVPN
• Cyberghost
• ExpressVPN
• FastestVPN
• Hidemyass
• IPVanish
• IVPN
• Mullvad
• NordVPN
• Perfect privacy
• Privado
• Private internet access
• PrivateVPN
• ProtonVPN (Recommended!)
• PureVPN
• SlickVPN
• Surfshark
• Torguard
• VPN Secure
• VPN Unlimited
• VyprVPN
• WeVPN
• Windscribe

You can also set up a custom VPN provider, but this is not officially supported for YAMS. You are on your own here.

Manual configuration

To manually configure your VPN, you have to edit your docker-compose.yaml and .env files.

First, stop YAMS:

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

$ vim /opt/yams/.env

On the file, make the following changes:

# 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

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.

$ vim /opt/yams/docker-compose.yaml

On the file, find the qbitorrent config and make the following changes:

...
    # ports: # qbittorrent -> Comment this line
    #  - 8081:8081 # qbittorrent -> Comment this line
    network_mode: "service:gluetun" -> Uncomment this line

Now, find the sabnzbd config and make the following changes:

...
    # ports: # sabnzbd -> Comment this line 
    # - 8080:8080 # sabnzbd -> Comment this line 
    network_mode: "service:gluetun" -> Uncomment this line
...

Then, at the bottom, find the gluetun config and make the following changes:

...
      - 8080:8080/tcp # gluetun -> Uncomment this line
      - 8081:8081/tcp # gluetun -> Uncomment this line

Now, restart YAMS:

$ yams restart

Finally, check that your VPN is running correctly:

$ yams check-vpn

Getting your qBittorrent IP...
<your_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 it's not running correctly, check every setting and make sure they are all correct.

Double-check your torrent client IP address

Go here.