rogs/yams.media
rogs/yams.media
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases Wiki Activity

Added .env config for VPN setup in YAMS documentation

Browse Source
This commit is contained in:
Roger Gonzalez 2024-12-23 11:21:16 -03:00
parent a64c52e5b1
commit 22941325f0
Signed by: rogs
GPG Key ID: C7ECE9C6C36EC2E6
1 changed files with 27 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

35
content/advanced/vpn.md
View File

@ -40,13 +40,28 @@ You can also set up a [custom VPN provider](https://github.com/qdm12/gluetun-wik
## Manual configuration
To manually configure your VPN, you have to edit your `docker-compose.yaml` file.
To manually configure your VPN, you have to edit your `docker-compose.yaml` and `.env` files.
First, stop `YAMS`:
```bash
$ 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.
```bash
$ vim /opt/yams/.env
```
On the file, make the following changes:
```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
```
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
@ -58,21 +73,25 @@ On the file, find the `qbitorrent` config and make the following changes:
```yaml
...
# ports: # qbittorrent -> Comment this line
# - 8080:8080 # 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:
```yaml
...
# 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:
```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
- 8081:8081/tcp # gluetun -> Uncomment this line
```
Now, restart `YAMS`: