Skip to content

Update DelugeVPN configuration documentation #405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
andy-vdg wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Update DelugeVPN configuration documentation #405

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c57eb4c
Update DelugeVPN configuration documentation
andy-vdg May 24, 2026
3ce9b0c
Update DelugeVPN documentation for PIA WireGuard
andy-vdg May 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
133 changes: 33 additions & 100 deletions docs/sandbox/apps/delugevpn.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,135 +46,68 @@ saltbox_automation:
---
<!-- END SALTBOX MANAGED OVERVIEW SECTION -->

## Deployment

```shell
sb install sandbox-delugevpn
```

## Usage
## Configuration

Visit <https://delugevpn.iYOUR_DOMAIN_NAMEi>.
See the parent [Deluge](../../apps/deluge.md) role for app setup.

@keldian keldian May 24, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a Usage step and shouldn't be under Configuration.

For the rest, my comments from your qbittorrentvpn PR apply. I appreciate your work identifying and removing outdated material, but we'd prefer sandbox guides be as concise as possible and focus on the bare essentials.


## Basics
Configuration for this role is set through the Saltbox inventory.

See the parent [Deluge](../../apps/deluge.md) role for app setup.
See: https://docs.saltbox.dev/saltbox/inventory/

- Edit the DelugeVPN settings in the delugevpn section in Sandbox `settings.yml` as shown below.
Edit the inventory:

```yaml
delugevpn:
vpn_endpoint: netherlands.ovpn
vpn_pass: your_vpn_password
vpn_prov: pia
vpn_user: your_vpn_username
vpn_client: wireguard # 'wireguard' or 'openvpn'
```
```shell
sb edit inventory
```

**For Private Internet Access** <br />
### PIA VPN

- Add your user name and password
- Change the vpn_endpoint to your chosen server. Note that PIA occasionally changes which servers have port forwarding. The Netherlands server no longer offers port forwarding. See configuration section for more details.
Add or update the following variables:

**For other VPN providers** <br />
```yaml
delugevpn_role_vpn_prov: "pia"
delugevpn_role_vpn_client: "wireguard"
delugevpn_role_vpn_user: "your_vpn_username"
delugevpn_role_vpn_pass: "your_vpn_password"
```

- Add your user name and password
- Change `vpn_prov` to `custom`
- Leave `vpn_endpoint` as `netherlands.ovpn`
- Follow step 2 below then immediately follow step 3
Then deploy the role.

### Run the DelugeVPN Role
The WireGuard configuration is generated in:

```shell
sb install sandbox-delugevpn
/opt/delugevpn/wireguard/wg0.conf
```

### Configuring Server for Custom VPN providers (only for non-pia)**
For PIA WireGuard users, the generated `wg0.conf` file persists across normal Saltbox redeploys and updates unless the appdata directory or the `wg0.conf` file is removed.

Why you need to do this
To check or change the selected endpoint, inspect or edit the `Endpoint =` line in `wg0.conf`, then restart the container.

For custom VPN providers, delugevpn needs an ovpn file to complete the install properly. It can check for a custom file in the `/opt/delugevpn/openvpn` folder, but this folder does not yet exist. Therefore, we will first use PIA's `netherlands.ovpn` file, which we will modify later to have our own VPN provider details.
Example:

The steps above have created some files in `/opt/delugevpn/openvpn`.
```ini
Endpoint = france.pvt.site:1337
```

- `ca.rsa.2048.crt` - Leave this
- `crl.rsa.2048.pem` - Leave this
- `credentials.conf` - Leave this. Your VPN username and password are stored here.
- `netherlands.ovpn` - Your server details are stored here. We will change this.
PIA changes its available endpoints and port-forwarding support over time. To see the current list of available PIA WireGuard endpoints, check the container logs after startup:

```shell
docker stop delugevpn
cd /opt/delugevpn/openvpn
rm netherlands.ovpn
docker logs delugevpn | grep ".pvt.site"
```

Now you can upload your own .ovpn file from your VPN provider, renamed as `netherlands.ovpn`. If your VPN provider has also included a `ca.crt` file, upload that file as well. Upload one or both files into `/opt/delugevpn/openvpn`.
Choose a listed endpoint that supports port forwarding, then set it in `wg0.conf`.

### Note
The underlying Binhex image supports OpenVPN and WireGuard and uses iptables to prevent IP leakage when the VPN tunnel is down.

Do not rename the original `netherlands.ovpn` file if you're using Filezilla. delugevpn will automatically use the renamed file instead of `netherlands.ovpn` and your newly uploaded .ovpn file will still be ignored.

Now you can restart the docker
## Deployment

```shell
docker start delugevpn
sb install sandbox-delugevpn
```

## Configuration
## Usage

### FOR PIA

- **vpn_user:** Your PIA user name

- **vpn_pass:** Your PIA password

- **vpn_prov:** pia

- **vpn_endpoint:** netherlands.ovpn

**Included PIA OpenVPN end point options are.**

| **Endpoint** | **Endpoint** | **Endpoint** | **Endpoint** |
|: ------------- |: ------------- |: ------------- |: ------------- |
| albania.ovpn | egypt.ovpn | monaco.ovpn | uk_london.ovp |
| algeria.ovpn | finland.ovpn | mongolia.ovpn | uk_manchester.ovpn |
| andorra.ovpn | france.ovpn | montenegro.ovpn | uk_southampton.ovpn |
| argentina.ovpn | georgia.ovpn | morocco.ovpn | ukraine.ovpn |
| armenia.ovpn | greece.ovpn | netherlands.ovpn | united_arab_emirates.ovpn |
| au_melbourne.ovpn | greenland.ovpn | new_zealand.ovpn | us_atlanta.ovpn |
| au_perth.ovpn | hong_kong.ovpn | nigeria.ovpn | us_california.ovpn |
| au_sydney.ovpn | hungary.ovpn | norway.ovpn | us_chicago.ovpn |
| austria.ovpn | iceland.ovpn | panama.ovpn | us_denver.ovpn |
| bahamas.ovpn | india.ovpn | philippines.ovpn | us_east.ovpn |
| bangladesh.ovpn | ireland.ovpn | poland.ovpn | us_florida.ovpn |
| belgium.ovpn | isle_of_man.ovpn | portugal.ovpn | us_houston.ovpn |
| brazil.ovpn | israel.ovpn | qatar.ovpn | us_las_vegas.ovpn |
| bulgaria.ovpn | italy.ovpn | romania.ovpn | us_new_york.ovpn |
| ca_montreal.ovpn | japan.ovpn | saudi_arabia.ovpn | us_seattle.ovpn |
| ca_ontario.ovpn | kazakhstan.ovpn | serbia.ovpn | us_silicon_valley.ovpn |
| ca_toronto.ovpn | latvia.ovpn | singapore.ovpn | us_texas.ovpn |
| ca_vancouver.ovpn | liechtenstein.ovpn | slovakia.ovpn | us_washington_dc.ovpn |
| cambodia.ovpn | lithuania.ovpn | south_africa.ovpn | us_west.ovpn |
| china.ovpn | luxembourg.ovpn | spain.ovpn | venezuela.ovpn |
| cyprus.ovpn | macao.ovpn | sri_lanka.ovpn | vietnam.ovpn |
| czech_republic.ovpn | macedonia.ovpn | sweden.ovpn |
| de_berlin.ovpn | malta.ovpn | switzerland.ovpn |
| de_frankfurt.ovpn | mexico.ovpn | taiwan.ovpn |
| denmark.ovpn | moldova.ovpn | turkey.ovpn |

As of July 4, 2020, the PIA servers that allow port forwarding, and DelugeVPN to work properly, are: CA Toronto, CA Montreal, CA Vancouver, Czech Republic, DE Berlin, DE Frankfurt, France, Israel, Romania, Spain, Switzerland, Sweden. Check the PIA website for changes if these servers do not work.

### Tips

- If you run into issues check `settings.yml` modified during pre install setup.
- If your endpoint has spaces you can use single quotes in the settings.yml ex.) `vpn_endpoint: 'CA Toronto.ovpn'`
- After checking/fixing `settings.yml` execute `sudo rm -rf /opt/delugevpn`
- **WARNING:** this will delete all files and folder in /opt/delugevpn, backup first if you need anything)
- Follow installation steps above again

### For app specific instructions refer to the parent role

- [Deluge](../../apps/deluge.md)
Visit <https://delugevpn.YOUR_DOMAIN_NAME>.

<!-- BEGIN SALTBOX MANAGED VARIABLES SECTION -->
<!-- This section is managed by sb-docs - DO NOT EDIT MANUALLY -->
Expand Down