Skip to content

Commit

Permalink
Update gluetun.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chazlarson authored Feb 16, 2024
1 parent 70a9f1c commit ff76934
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/apps/gluetun.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@

The Gluetun role is configured via the [inventory system](../saltbox/inventory/index.md). It is recommended to review the upstream documentation for your VPN provider to determine the proper configuration. The following variables are available to set and correspond to the similarly named Docker envs.

Any values that contain special characters or are entirely numeric should be wrapped in quotes:


```yaml
gluetun_vpn_service_provider: ""
gluetun_vpn_type: ""
Expand All @@ -35,6 +38,18 @@ gluetun_firewall_input_ports: ""
gluetun_firewall_outbound_subnets: ""
```
!!! caution
Any values which are entirely numeric or contain special characters should be wrapped in quotes:
```yaml
gluetun_openvpn_user: "ePWh!Y^fs6p%B*6S"
gluetun_openvpn_password: "qA5V6&#ASx4DY8qG"
gluetun_vpn_endpoint_port: "12345"
```
Generally speaking it's safest to just wrap everything in quotes rather than worrying about what needs to be. Quotes are plentiful and free.
!!! warning
The role uses the built-in Docker DNS resolver by default instead of using the DoH/DoT functionality Gluetun normally provides.
Expand Down

0 comments on commit ff76934

Please sign in to comment.