summaryrefslogtreecommitdiff
path: root/content/advanced/vpn.md
blob: 42870249c62b78fd461e006e1bef83dffb847e68 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
---
title: "VPN"
date: 2023-01-15T21:16:29-03:00
draft: false
weight: 1
summary: Advanced configuration for the VPN, supported VPN lists and manual configuration.
---

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

YAMS uses [gluetun](https://github.com/qdm12/gluetun) for VPN.

## Official supported VPNs

- [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)
- [FastestVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/fastestvpn.md)
- [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) **(Recommended!)**
- [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)
- [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)
- [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)
- [VyprVPN](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/vyprvpn.md)
- [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-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` file.

First, stop `YAMS`:
```bash
$ yams stop
```

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.

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

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

```yaml
...
    # ports: # qbittorrent -> Comment this line
    #  - 8080:8080 # qbittorrent -> Comment this line
    network_mode: "service:gluetun" -> Uncomment this line
```

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

```yaml
...
      - 8080:8080/tcp # gluetun -> Uncomment this line
...
    environment:
      - VPN_SERVICE_PROVIDER=<vpn_service> # -> Replace "<vpn_service>" with your VPN service provider
      - VPN_TYPE=openvpn
      - OPENVPN_USER=<vpn_user> # -> Replace "<vpn_user>" with your VPN username
      - OPENVPN_PASSWORD=<vpn_password> # -> Replace "<vpn_password>" with your VPN password
      - SERVER_COUNTRIES=<vpn_country> # -> Replacee "<vpn_country>" with your VPN country
```

Now, restart `YAMS`:

```bash
$ yams restart
```

Finally, check that your VPN is running correctly:

```bash
$ 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](/advanced/torrenting/#double-checking-your-torrent-client-ip-address).