Skip to content

Gluetun

Overview

Gluetun is a VPN client in a thin Docker container for multiple VPN providers, written in Go, and using OpenVPN or Wireguard, DNS over TLS, with a few proxy servers built-in.


Configuration

The Gluetun role is configured via the inventory system. 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.

gluetun_vpn_service_provider: ""
gluetun_vpn_type: ""
gluetun_openvpn_custom_config: ""
gluetun_openvpn_endpoint_ip: ""
gluetun_openvpn_endpoint_port: ""
gluetun_openvpn_user: ""
gluetun_openvpn_password: ""
gluetun_openvpn_key_passphrase: ""
gluetun_wireguard_endpoint_ip: ""
gluetun_wireguard_endpoint_port: ""
gluetun_wireguard_public_key: ""
gluetun_wireguard_private_key: ""
gluetun_wireguard_preshared_key: ""
gluetun_wireguard_addresses: ""
gluetun_wireguard_mtu: ""
gluetun_server_countries: ""
gluetun_server_cities: ""
gluetun_server_hostnames: ""
gluetun_server_names: ""
gluetun_server_regions: ""
gluetun_firewall_vpn_input_ports: ""
gluetun_firewall_input_ports: ""
gluetun_firewall_outbound_subnets: ""

Caution

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

gluetun_openvpn_user: "ePWh!Y^fs6p%B*6S"
gluetun_openvpn_password: "qA5V6&#ASx4DY8qG"
gluetun_openvpn_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.

Additional Docker envs may be set via gluetun_docker_envs_custom.

Route Plex through Gluetun

Caution

It is important to disable remote access in Plex when using this workaround to avoid having media traffic routed through the VPN. Multiple instances of Plex will need their own unique instance of gluetun due to port conflicts.

To route Plex via your Gluetun container, you must set the following via the inventory system. These settings will also DNS block the metrics servers and use Gluetun's HTTP proxy when connecting with the Plex API for Saltbox tasks such as generating auth tokens:

gluetun_docker_hosts_default:
  "metric.plex.tv": "{{ ip_address_localhost }}"
  "metrics.plex.tv": "{{ ip_address_localhost }}"
  "analytics.plex.tv": "{{ ip_address_localhost }}"

gluetun_docker_networks_alias_custom:
  - "plex"

plex_auth_token_proxy: "http://gluetun:8888"
plex_docker_network_mode_default: "container:gluetun"

# If using multiple instances.
gluetun2_docker_networks_alias_custom:
  - "plex2"
plex2_docker_network_mode_default: "container:gluetun2"
plex2_auth_token_proxy: "http://gluetun2:8888"

Once you have made these changes to the inventory, run the plex tag to apply the changes (i.e. sb install plex). This will update all your plex containers.

Caution

When routing Plex through Gluetun, you must access Plex between containers at http://gluetun:32400 where you would previously use the Plex container name.

The above note is only the case if you do not add each linked container alias to gluetun like in the config example above.

Additionally the Plex container will become unable to start if you redeploy gluetun (restart is fine) at any point so you must redeploy Plex in that case.

Route other containers through Gluetun

Depending on if the role in question supports instances or not there will be two ways to set the network mode.

To route a Saltbox-configured container through Gluetun, you must set <rolename_instance>_docker_network_mode_default: "container:gluetun" via the inventory system.

For example, to route qbittorrent through Gluetun, the entry would be qbittorrent_docker_network_mode_default: "container:gluetun".

For example, to route qbittorrent2 through Gluetun, the entry would be qbittorrent2_docker_network_mode_default: "container:gluetun2".

Important

The caveat with instances is that each instance will need a unique Gluetun instance to avoid port collision.

To route a Saltbox-configured container through Gluetun, you must set <rolename>_docker_network_mode: "container:gluetun" via the inventory system.

For example, to route jackett through Gluetun, the entry would be jackett_docker_network_mode: "container:gluetun".

Once you have made these changes to the inventory, run the relevant tags to apply the changes (i.e. sb install qbittorrent or sb install jackett,sonarr,radarr).

Caution

While multiple containers may be routed through a single Gluetun instance, you must manually ensure there are no port clashes as all port binds for the connected containers will be through the Gluetun container and must have unique ports inside that container.

Example Gluetun Configs

Below are some example inventory entries for some common VPN providers. These are intended as templates only and should not be expected to copy and paste without any edits. For a Wireguard implementation, you will typically generate a config file (wg0.conf) with the provider and grab some of the values from that config to configure Gluetun.

gluetun_vpn_service_provider: "custom"
gluetun_vpn_type: "wireguard"
gluetun_wireguard_private_key: "your_wireguard_private_key"
gluetun_wireguard_addresses: "your_wireguard_address_with_cidr"
gluetun_wireguard_public_key: "server_wireguard_public_key"
gluetun_wireguard_endpoint_ip: "wireguard_server_ip"
gluetun_wireguard_endpoint_port: "wireguard_server_port"
# Not always required (only if server is configured to use a pre-shared key)
gluetun_wireguard_preshared_key: "your_wireguard_preshared_key"
gluetun_vpn_service_provider: "protonvpn"
gluetun_openvpn_user: "your_openvpn_user"
gluetun_openvpn_password: "your_openvpn_password"
gluetun_docker_envs_custom:
  FREE_ONLY: "on"
gluetun_vpn_service_provider: "mullvad"
gluetun_vpn_type: "wireguard"
gluetun_wireguard_public_key: "your_wireguard_public_key"
gluetun_wireguard_private_key: "your_wireguard_private_key"
gluetun_wireguard_addresses: "your_wireguard_address"
# Include the below line to only connect to Amsterdam servers - replace with a different city if desired
gluetun_server_cities: "amsterdam"
gluetun_vpn_service_provider: "surfshark"
gluetun_vpn_type: "wireguard"
gluetun_wireguard_private_key: "your_wireguard_private_key"
gluetun_wireguard_addresses: "your_wireguard_address"
# Include the below line to only connect to Netherlands servers - replace with a different city if desired
gluetun_server_countries: "Netherlands"
gluetun_vpn_service_provider: "airvpn"
gluetun_vpn_type: "wireguard"
gluetun_wireguard_public_key: "your_wireguard_public_key"
gluetun_wireguard_private_key: "your_wireguard_private_key"
gluetun_wireguard_preshared_key: "your_wireguard_preshared_key"
gluetun_wireguard_addresses: "your_wireguard_address"
# Configure via a ovpn file located on the host at `/opt/gluetun/custom.ovpn`.
gluetun_vpn_service_provider: "custom"
gluetun_vpn_type: "openvpn"
gluetun_openvpn_custom_config: "/gluetun/custom.ovpn"

Deployment

sb install gluetun

Usage

To verify VPN connectivity, inspect the container's IP address:

docker exec gluetun curl ifconfig.me

Role Defaults

Use the Inventory to customize variables. (1)

  1. This role supports multiple instances via gluetun_instances.

    Example override

    gluetun_role_web_subdomain: "custom"
    

    Applies to all instances of gluetun

    gluetun2_web_subdomain: "custom2"
    

    Applies to the instance named gluetun2

    Avoid overriding variables ending in _default

    When overriding variables that end in _default (like gluetun_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

    Instead, use the corresponding _custom variable (like gluetun_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

gluetun_instances
# Type: list
gluetun_instances: ["gluetun"]

Example Override

# Type: list
gluetun_instances: ["gluetun", "gluetun2"]

This section is organized into multiple subsections

gluetun_role_vpn_service_providergluetun2_vpn_service_provider
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN service provider (e.g., mullvad, nordvpn, private internet access, etc.)
# Type: string
gluetun_role_vpn_service_provider: ""
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN service provider (e.g., mullvad, nordvpn, private internet access, etc.)
# Type: string
gluetun2_vpn_service_provider: ""
gluetun_role_vpn_typegluetun2_vpn_type
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN type: openvpn or wireguard
# Type: string
gluetun_role_vpn_type: ""
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN type: openvpn or wireguard
# Type: string
gluetun2_vpn_type: ""
gluetun_role_vpn_interfacegluetun2_vpn_interface
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Network interface name for the VPN tunnel (e.g., tun0, wg0)
# Type: string
gluetun_role_vpn_interface: ""
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Network interface name for the VPN tunnel (e.g., tun0, wg0)
# Type: string
gluetun2_vpn_interface: ""
gluetun_role_vpn_endpoint_ipgluetun2_vpn_endpoint_ip
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN server endpoint IP address (optional override)
# Type: string
gluetun_role_vpn_endpoint_ip: ""
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN server endpoint IP address (optional override)
# Type: string
gluetun2_vpn_endpoint_ip: ""
gluetun_role_vpn_endpoint_portgluetun2_vpn_endpoint_port
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN server endpoint port (optional override)
# Type: string
gluetun_role_vpn_endpoint_port: ""
# Reference: https://github.com/qdm12/gluetun-wiki
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# VPN server endpoint port (optional override)
# Type: string
gluetun2_vpn_endpoint_port: ""
gluetun_role_openvpn_usergluetun2_openvpn_user
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN username for authentication
# Type: string
gluetun_role_openvpn_user: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN username for authentication
# Type: string
gluetun2_openvpn_user: ""
gluetun_role_openvpn_passwordgluetun2_openvpn_password
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN password for authentication
# Type: string
gluetun_role_openvpn_password: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN password for authentication
# Type: string
gluetun2_openvpn_password: ""
gluetun_role_openvpn_protocolgluetun2_openvpn_protocol
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN protocol: udp or tcp
# Type: string
gluetun_role_openvpn_protocol: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN protocol: udp or tcp
# Type: string
gluetun2_openvpn_protocol: ""
gluetun_role_openvpn_endpoint_ipgluetun2_openvpn_endpoint_ip
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN server endpoint IP (optional override)
# Type: string
gluetun_role_openvpn_endpoint_ip: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN server endpoint IP (optional override)
# Type: string
gluetun2_openvpn_endpoint_ip: ""
gluetun_role_openvpn_endpoint_portgluetun2_openvpn_endpoint_port
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN server endpoint port (optional override)
# Type: string
gluetun_role_openvpn_endpoint_port: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN server endpoint port (optional override)
# Type: string
gluetun2_openvpn_endpoint_port: ""
gluetun_role_openvpn_versiongluetun2_openvpn_version
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN version: 2.5 or 2.6
# Type: string
gluetun_role_openvpn_version: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN version: 2.5 or 2.6
# Type: string
gluetun2_openvpn_version: ""
gluetun_role_openvpn_verbositygluetun2_openvpn_verbosity
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN verbosity level (0-6)
# Type: string
gluetun_role_openvpn_verbosity: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN verbosity level (0-6)
# Type: string
gluetun2_openvpn_verbosity: ""
gluetun_role_openvpn_flagsgluetun2_openvpn_flags
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Additional OpenVPN flags to pass to the openvpn command
# Type: string
gluetun_role_openvpn_flags: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Additional OpenVPN flags to pass to the openvpn command
# Type: string
gluetun2_openvpn_flags: ""
gluetun_role_openvpn_ciphersgluetun2_openvpn_ciphers
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Comma-separated list of ciphers to use
# Type: string
gluetun_role_openvpn_ciphers: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Comma-separated list of ciphers to use
# Type: string
gluetun2_openvpn_ciphers: ""
gluetun_role_openvpn_authgluetun2_openvpn_auth
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN auth algorithm (e.g., sha256, sha512)
# Type: string
gluetun_role_openvpn_auth: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN auth algorithm (e.g., sha256, sha512)
# Type: string
gluetun2_openvpn_auth: ""
gluetun_role_openvpn_process_usergluetun2_openvpn_process_user
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# User to run OpenVPN process as (e.g., root, nonroot)
# Type: string
gluetun_role_openvpn_process_user: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# User to run OpenVPN process as (e.g., root, nonroot)
# Type: string
gluetun2_openvpn_process_user: ""
gluetun_role_openvpn_mssfixgluetun2_openvpn_mssfix
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN MSS fix value
# Type: string
gluetun_role_openvpn_mssfix: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN MSS fix value
# Type: string
gluetun2_openvpn_mssfix: ""
gluetun_role_openvpn_custom_configgluetun2_openvpn_custom_config
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Path to custom OpenVPN configuration file
# Type: string
gluetun_role_openvpn_custom_config: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Path to custom OpenVPN configuration file
# Type: string
gluetun2_openvpn_custom_config: ""
gluetun_role_openvpn_certgluetun2_openvpn_cert
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN client certificate (base64 or path)
# Type: string
gluetun_role_openvpn_cert: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN client certificate (base64 or path)
# Type: string
gluetun2_openvpn_cert: ""
gluetun_role_openvpn_keygluetun2_openvpn_key
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN client private key (base64 or path)
# Type: string
gluetun_role_openvpn_key: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# OpenVPN client private key (base64 or path)
# Type: string
gluetun2_openvpn_key: ""
gluetun_role_openvpn_encrypted_keygluetun2_openvpn_encrypted_key
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Set to "yes" if the OpenVPN key is encrypted
# Type: string
gluetun_role_openvpn_encrypted_key: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Set to "yes" if the OpenVPN key is encrypted
# Type: string
gluetun2_openvpn_encrypted_key: ""
gluetun_role_openvpn_key_passphrasegluetun2_openvpn_key_passphrase
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Passphrase to decrypt the OpenVPN key
# Type: string
gluetun_role_openvpn_key_passphrase: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md
# Passphrase to decrypt the OpenVPN key
# Type: string
gluetun2_openvpn_key_passphrase: ""
gluetun_role_wireguard_private_keygluetun2_wireguard_private_key
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard client private key
# Type: string
gluetun_role_wireguard_private_key: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard client private key
# Type: string
gluetun2_wireguard_private_key: ""
gluetun_role_wireguard_preshared_keygluetun2_wireguard_preshared_key
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard preshared key for additional security
# Type: string
gluetun_role_wireguard_preshared_key: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard preshared key for additional security
# Type: string
gluetun2_wireguard_preshared_key: ""
gluetun_role_wireguard_public_keygluetun2_wireguard_public_key
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard server public key
# Type: string
gluetun_role_wireguard_public_key: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard server public key
# Type: string
gluetun2_wireguard_public_key: ""
gluetun_role_wireguard_addressesgluetun2_wireguard_addresses
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# Comma-separated list of IP addresses for the WireGuard interface
# Type: string
gluetun_role_wireguard_addresses: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# Comma-separated list of IP addresses for the WireGuard interface
# Type: string
gluetun2_wireguard_addresses: ""
gluetun_role_wireguard_allowed_ipsgluetun2_wireguard_allowed_ips
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# Comma-separated list of allowed IP ranges
# Type: string
gluetun_role_wireguard_allowed_ips: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# Comma-separated list of allowed IP ranges
# Type: string
gluetun2_wireguard_allowed_ips: ""
gluetun_role_wireguard_endpoint_ipgluetun2_wireguard_endpoint_ip
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard server endpoint IP (optional override)
# Type: string
gluetun_role_wireguard_endpoint_ip: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard server endpoint IP (optional override)
# Type: string
gluetun2_wireguard_endpoint_ip: ""
gluetun_role_wireguard_endpoint_portgluetun2_wireguard_endpoint_port
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard server endpoint port (optional override)
# Type: string
gluetun_role_wireguard_endpoint_port: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard server endpoint port (optional override)
# Type: string
gluetun2_wireguard_endpoint_port: ""
gluetun_role_wireguard_mtugluetun2_wireguard_mtu
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard MTU value
# Type: string
gluetun_role_wireguard_mtu: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard MTU value
# Type: string
gluetun2_wireguard_mtu: ""
gluetun_role_wireguard_implementationgluetun2_wireguard_implementation
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard implementation: kernelspace or userspace
# Type: string
gluetun_role_wireguard_implementation: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard implementation: kernelspace or userspace
# Type: string
gluetun2_wireguard_implementation: ""
gluetun_role_wireguard_persistent_keepalive_intervalgluetun2_wireguard_persistent_keepalive_interval
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard persistent keepalive interval (e.g., 25s)
# Type: string
gluetun_role_wireguard_persistent_keepalive_interval: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md
# WireGuard persistent keepalive interval (e.g., 25s)
# Type: string
gluetun2_wireguard_persistent_keepalive_interval: ""
gluetun_role_server_regionsgluetun2_server_regions
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server regions
# Type: string
gluetun_role_server_regions: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server regions
# Type: string
gluetun2_server_regions: ""
gluetun_role_server_countriesgluetun2_server_countries
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server countries
# Type: string
gluetun_role_server_countries: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server countries
# Type: string
gluetun2_server_countries: ""
gluetun_role_server_citiesgluetun2_server_cities
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server cities
# Type: string
gluetun_role_server_cities: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server cities
# Type: string
gluetun2_server_cities: ""
gluetun_role_server_hostnamesgluetun2_server_hostnames
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server hostnames
# Type: string
gluetun_role_server_hostnames: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server hostnames
# Type: string
gluetun2_server_hostnames: ""
gluetun_role_server_namesgluetun2_server_names
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server names
# Type: string
gluetun_role_server_names: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server names
# Type: string
gluetun2_server_names: ""
gluetun_role_server_categoriesgluetun2_server_categories
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server categories
# Type: string
gluetun_role_server_categories: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Comma-separated list of server categories
# Type: string
gluetun2_server_categories: ""
gluetun_role_server_numbergluetun2_server_number
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Server number (provider-specific)
# Type: string
gluetun_role_server_number: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Server number (provider-specific)
# Type: string
gluetun2_server_number: ""
gluetun_role_ispgluetun2_isp
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Filter by ISP name
# Type: string
gluetun_role_isp: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Filter by ISP name
# Type: string
gluetun2_isp: ""
gluetun_role_owned_onlygluetun2_owned_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use servers owned by the VPN provider (on/off)
# Type: string
gluetun_role_owned_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use servers owned by the VPN provider (on/off)
# Type: string
gluetun2_owned_only: ""
gluetun_role_stream_onlygluetun2_stream_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use servers optimized for streaming (on/off)
# Type: string
gluetun_role_stream_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use servers optimized for streaming (on/off)
# Type: string
gluetun2_stream_only: ""
gluetun_role_free_onlygluetun2_free_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use free tier servers (on/off)
# Type: string
gluetun_role_free_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use free tier servers (on/off)
# Type: string
gluetun2_free_only: ""
gluetun_role_premium_onlygluetun2_premium_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use premium tier servers (on/off)
# Type: string
gluetun_role_premium_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use premium tier servers (on/off)
# Type: string
gluetun2_premium_only: ""
gluetun_role_secure_core_onlygluetun2_secure_core_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use Secure Core servers - ProtonVPN (on/off)
# Type: string
gluetun_role_secure_core_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use Secure Core servers - ProtonVPN (on/off)
# Type: string
gluetun2_secure_core_only: ""
gluetun_role_tor_onlygluetun2_tor_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use Tor-enabled servers (on/off)
# Type: string
gluetun_role_tor_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use Tor-enabled servers (on/off)
# Type: string
gluetun2_tor_only: ""
gluetun_role_multihop_onlygluetun2_multihop_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use multi-hop servers (on/off)
# Type: string
gluetun_role_multihop_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use multi-hop servers (on/off)
# Type: string
gluetun2_multihop_only: ""
gluetun_role_port_forward_onlygluetun2_port_forward_only
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use servers that support port forwarding (on/off)
# Type: string
gluetun_role_port_forward_only: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn-server-selection.md
# Only use servers that support port forwarding (on/off)
# Type: string
gluetun2_port_forward_only: ""
gluetun_role_firewall_vpn_input_portsgluetun2_firewall_vpn_input_ports
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Comma-separated list of ports to allow through the VPN firewall
# Type: string
gluetun_role_firewall_vpn_input_ports: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Comma-separated list of ports to allow through the VPN firewall
# Type: string
gluetun2_firewall_vpn_input_ports: ""
gluetun_role_firewall_input_portsgluetun2_firewall_input_ports
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Comma-separated list of ports to allow on the host side
# Type: string
gluetun_role_firewall_input_ports: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Comma-separated list of ports to allow on the host side
# Type: string
gluetun2_firewall_input_ports: ""
gluetun_role_firewall_outbound_subnetsgluetun2_firewall_outbound_subnets
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Comma-separated list of subnets to allow outbound traffic to
# Type: string
gluetun_role_firewall_outbound_subnets: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Comma-separated list of subnets to allow outbound traffic to
# Type: string
gluetun2_firewall_outbound_subnets: ""
gluetun_role_firewall_debuggluetun2_firewall_debug
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Enable firewall debug logging (on/off)
# Type: string
gluetun_role_firewall_debug: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md
# Enable firewall debug logging (on/off)
# Type: string
gluetun2_firewall_debug: ""
gluetun_role_dns_servergluetun2_dns_server
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# DNS server type: local or remote
# Type: string
gluetun_role_dns_server: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# DNS server type: local or remote
# Type: string
gluetun2_dns_server: ""
gluetun_role_dns_upstream_resolver_typegluetun2_dns_upstream_resolver_type
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Upstream resolver type: dot, doh, or plaintext
# Type: string
gluetun_role_dns_upstream_resolver_type: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Upstream resolver type: dot, doh, or plaintext
# Type: string
gluetun2_dns_upstream_resolver_type: ""
gluetun_role_dns_upstream_resolversgluetun2_dns_upstream_resolvers
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of upstream DNS resolvers
# Type: string
gluetun_role_dns_upstream_resolvers: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of upstream DNS resolvers
# Type: string
gluetun2_dns_upstream_resolvers: ""
gluetun_role_dns_cachinggluetun2_dns_caching
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Enable DNS caching (on/off)
# Type: string
gluetun_role_dns_caching: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Enable DNS caching (on/off)
# Type: string
gluetun2_dns_caching: ""
gluetun_role_dns_upstream_ipv6gluetun2_dns_upstream_ipv6
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Allow IPv6 DNS queries (on/off)
# Type: string
gluetun_role_dns_upstream_ipv6: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Allow IPv6 DNS queries (on/off)
# Type: string
gluetun2_dns_upstream_ipv6: ""
gluetun_role_dns_block_ipsgluetun2_dns_block_ips
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of IPs to block in DNS responses
# Type: string
gluetun_role_dns_block_ips: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of IPs to block in DNS responses
# Type: string
gluetun2_dns_block_ips: ""
gluetun_role_dns_block_ip_prefixesgluetun2_dns_block_ip_prefixes
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of IP prefixes to block in DNS responses
# Type: string
gluetun_role_dns_block_ip_prefixes: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of IP prefixes to block in DNS responses
# Type: string
gluetun2_dns_block_ip_prefixes: ""
gluetun_role_block_maliciousgluetun2_block_malicious
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Block malicious domains (on/off)
# Type: string
gluetun_role_block_malicious: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Block malicious domains (on/off)
# Type: string
gluetun2_block_malicious: ""
gluetun_role_block_surveillancegluetun2_block_surveillance
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Block surveillance domains (on/off)
# Type: string
gluetun_role_block_surveillance: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Block surveillance domains (on/off)
# Type: string
gluetun2_block_surveillance: ""
gluetun_role_block_adsgluetun2_block_ads
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Block ads domains (on/off)
# Type: string
gluetun_role_block_ads: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Block ads domains (on/off)
# Type: string
gluetun2_block_ads: ""
gluetun_role_dns_unblock_hostnamesgluetun2_dns_unblock_hostnames
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of hostnames to unblock
# Type: string
gluetun_role_dns_unblock_hostnames: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of hostnames to unblock
# Type: string
gluetun2_dns_unblock_hostnames: ""
gluetun_role_dns_rebinding_protection_exempt_hostnamesgluetun2_dns_rebinding_protection_exempt_hostnames
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of hostnames exempt from DNS rebinding protection
# Type: string
gluetun_role_dns_rebinding_protection_exempt_hostnames: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of hostnames exempt from DNS rebinding protection
# Type: string
gluetun2_dns_rebinding_protection_exempt_hostnames: ""
gluetun_role_dns_private_addressesgluetun2_dns_private_addresses
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of private address ranges for DNS
# Type: string
gluetun_role_dns_private_addresses: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Comma-separated list of private address ranges for DNS
# Type: string
gluetun2_dns_private_addresses: ""
gluetun_role_dns_update_periodgluetun2_dns_update_period
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# DNS blocklists update period (e.g., 24h)
# Type: string
gluetun_role_dns_update_period: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# DNS blocklists update period (e.g., 24h)
# Type: string
gluetun2_dns_update_period: ""
gluetun_role_dns_addressgluetun2_dns_address
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Address for DNS server to listen on (e.g., 127.0.0.1:53)
# Type: string
gluetun_role_dns_address: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Address for DNS server to listen on (e.g., 127.0.0.1:53)
# Type: string
gluetun2_dns_address: ""
gluetun_role_docker_resolvergluetun2_docker_resolver
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Keep original nameserver - deprecated in v3.41+, Saltbox default: false
# Type: bool (true/false)
gluetun_role_docker_resolver: false
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md
# Keep original nameserver - deprecated in v3.41+, Saltbox default: false
# Type: bool (true/false)
gluetun2_docker_resolver: false
gluetun_role_health_server_addressgluetun2_health_server_address
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Address for the health server to listen on
# Type: string
gluetun_role_health_server_address: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Address for the health server to listen on
# Type: string
gluetun2_health_server_address: ""
gluetun_role_health_target_addressesgluetun2_health_target_addresses
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Comma-separated list of addresses to check for health
# Type: string
gluetun_role_health_target_addresses: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Comma-separated list of addresses to check for health
# Type: string
gluetun2_health_target_addresses: ""
gluetun_role_health_icmp_target_ipsgluetun2_health_icmp_target_ips
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Comma-separated list of IP addresses for ICMP health checks
# Type: string
gluetun_role_health_icmp_target_ips: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Comma-separated list of IP addresses for ICMP health checks
# Type: string
gluetun2_health_icmp_target_ips: ""
gluetun_role_health_small_check_typegluetun2_health_small_check_type
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Type of small health check: ping or http
# Type: string
gluetun_role_health_small_check_type: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Type of small health check: ping or http
# Type: string
gluetun2_health_small_check_type: ""
gluetun_role_health_restart_vpngluetun2_health_restart_vpn
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Restart VPN when unhealthy (on/off)
# Type: string
gluetun_role_health_restart_vpn: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md
# Restart VPN when unhealthy (on/off)
# Type: string
gluetun2_health_restart_vpn: ""
gluetun_role_httpproxygluetun2_httpproxy
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Enable HTTP proxy (on/off)
# Type: string
gluetun_role_httpproxy: "on"
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Enable HTTP proxy (on/off)
# Type: string
gluetun2_httpproxy: "on"
gluetun_role_httpproxy_stealthgluetun2_httpproxy_stealth
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Enable stealth mode for HTTP proxy (on/off)
# Type: string
gluetun_role_httpproxy_stealth: "on"
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Enable stealth mode for HTTP proxy (on/off)
# Type: string
gluetun2_httpproxy_stealth: "on"
gluetun_role_httpproxy_loggluetun2_httpproxy_log
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Enable HTTP proxy logging (on/off)
# Type: string
gluetun_role_httpproxy_log: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Enable HTTP proxy logging (on/off)
# Type: string
gluetun2_httpproxy_log: ""
gluetun_role_httpproxy_listening_addressgluetun2_httpproxy_listening_address
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Address for HTTP proxy to listen on (e.g., :8888)
# Type: string
gluetun_role_httpproxy_listening_address: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# Address for HTTP proxy to listen on (e.g., :8888)
# Type: string
gluetun2_httpproxy_listening_address: ""
gluetun_role_httpproxy_usergluetun2_httpproxy_user
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# HTTP proxy authentication username
# Type: string
gluetun_role_httpproxy_user: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# HTTP proxy authentication username
# Type: string
gluetun2_httpproxy_user: ""
gluetun_role_httpproxy_passwordgluetun2_httpproxy_password
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# HTTP proxy authentication password
# Type: string
gluetun_role_httpproxy_password: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md
# HTTP proxy authentication password
# Type: string
gluetun2_httpproxy_password: ""
gluetun_role_shadowsocksgluetun2_shadowsocks
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Enable Shadowsocks server (on/off)
# Type: string
gluetun_role_shadowsocks: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Enable Shadowsocks server (on/off)
# Type: string
gluetun2_shadowsocks: ""
gluetun_role_shadowsocks_loggluetun2_shadowsocks_log
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Enable Shadowsocks logging (on/off)
# Type: string
gluetun_role_shadowsocks_log: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Enable Shadowsocks logging (on/off)
# Type: string
gluetun2_shadowsocks_log: ""
gluetun_role_shadowsocks_listening_addressgluetun2_shadowsocks_listening_address
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Address for Shadowsocks to listen on (e.g., :8388)
# Type: string
gluetun_role_shadowsocks_listening_address: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Address for Shadowsocks to listen on (e.g., :8388)
# Type: string
gluetun2_shadowsocks_listening_address: ""
gluetun_role_shadowsocks_passwordgluetun2_shadowsocks_password
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Shadowsocks password for authentication
# Type: string
gluetun_role_shadowsocks_password: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Shadowsocks password for authentication
# Type: string
gluetun2_shadowsocks_password: ""
gluetun_role_shadowsocks_ciphergluetun2_shadowsocks_cipher
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Shadowsocks cipher (e.g., chacha20-ietf-poly1305)
# Type: string
gluetun_role_shadowsocks_cipher: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md
# Shadowsocks cipher (e.g., chacha20-ietf-poly1305)
# Type: string
gluetun2_shadowsocks_cipher: ""
gluetun_role_http_control_server_loggluetun2_http_control_server_log
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Enable control server logging (on/off)
# Type: string
gluetun_role_http_control_server_log: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Enable control server logging (on/off)
# Type: string
gluetun2_http_control_server_log: ""
gluetun_role_http_control_server_addressgluetun2_http_control_server_address
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Address for control server to listen on (e.g., :8000)
# Type: string
gluetun_role_http_control_server_address: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Address for control server to listen on (e.g., :8000)
# Type: string
gluetun2_http_control_server_address: ""
gluetun_role_http_control_server_auth_config_filepathgluetun2_http_control_server_auth_config_filepath
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Path to auth config file for control server
# Type: string
gluetun_role_http_control_server_auth_config_filepath: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Path to auth config file for control server
# Type: string
gluetun2_http_control_server_auth_config_filepath: ""
gluetun_role_http_control_server_auth_default_rolegluetun2_http_control_server_auth_default_role
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Default role for control server auth (admin/viewer/none)
# Type: string
gluetun_role_http_control_server_auth_default_role: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md
# Default role for control server auth (admin/viewer/none)
# Type: string
gluetun2_http_control_server_auth_default_role: ""
gluetun_role_vpn_port_forwardinggluetun2_vpn_port_forwarding
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Enable VPN port forwarding (on/off)
# Type: string
gluetun_role_vpn_port_forwarding: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Enable VPN port forwarding (on/off)
# Type: string
gluetun2_vpn_port_forwarding: ""
gluetun_role_vpn_port_forwarding_listening_portgluetun2_vpn_port_forwarding_listening_port
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Listening port for port forwarding
# Type: string
gluetun_role_vpn_port_forwarding_listening_port: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Listening port for port forwarding
# Type: string
gluetun2_vpn_port_forwarding_listening_port: ""
gluetun_role_vpn_port_forwarding_providergluetun2_vpn_port_forwarding_provider
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Port forwarding provider (e.g., protonvpn, pia)
# Type: string
gluetun_role_vpn_port_forwarding_provider: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Port forwarding provider (e.g., protonvpn, pia)
# Type: string
gluetun2_vpn_port_forwarding_provider: ""
gluetun_role_vpn_port_forwarding_status_filegluetun2_vpn_port_forwarding_status_file
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Path to file for storing port forwarding status
# Type: string
gluetun_role_vpn_port_forwarding_status_file: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Path to file for storing port forwarding status
# Type: string
gluetun2_vpn_port_forwarding_status_file: ""
gluetun_role_vpn_port_forwarding_usernamegluetun2_vpn_port_forwarding_username
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Username for port forwarding authentication
# Type: string
gluetun_role_vpn_port_forwarding_username: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Username for port forwarding authentication
# Type: string
gluetun2_vpn_port_forwarding_username: ""
gluetun_role_vpn_port_forwarding_passwordgluetun2_vpn_port_forwarding_password
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Password for port forwarding authentication
# Type: string
gluetun_role_vpn_port_forwarding_password: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Password for port forwarding authentication
# Type: string
gluetun2_vpn_port_forwarding_password: ""
gluetun_role_vpn_port_forwarding_up_commandgluetun2_vpn_port_forwarding_up_command
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Command to run when port forwarding is established
# Type: string
gluetun_role_vpn_port_forwarding_up_command: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Command to run when port forwarding is established
# Type: string
gluetun2_vpn_port_forwarding_up_command: ""
gluetun_role_vpn_port_forwarding_down_commandgluetun2_vpn_port_forwarding_down_command
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Command to run when port forwarding is terminated
# Type: string
gluetun_role_vpn_port_forwarding_down_command: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md
# Command to run when port forwarding is terminated
# Type: string
gluetun2_vpn_port_forwarding_down_command: ""
gluetun_role_updater_periodgluetun2_updater_period
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# Server list update period (e.g., 24h, 0 to disable)
# Type: string
gluetun_role_updater_period: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# Server list update period (e.g., 24h, 0 to disable)
# Type: string
gluetun2_updater_period: ""
gluetun_role_updater_min_ratiogluetun2_updater_min_ratio
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# Minimum ratio of servers to keep when updating
# Type: string
gluetun_role_updater_min_ratio: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# Minimum ratio of servers to keep when updating
# Type: string
gluetun2_updater_min_ratio: ""
gluetun_role_updater_vpn_service_providersgluetun2_updater_vpn_service_providers
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# Comma-separated list of VPN providers to update servers for
# Type: string
gluetun_role_updater_vpn_service_providers: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# Comma-separated list of VPN providers to update servers for
# Type: string
gluetun2_updater_vpn_service_providers: ""
gluetun_role_updater_protonvpn_emailgluetun2_updater_protonvpn_email
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# ProtonVPN account email for server list updates
# Type: string
gluetun_role_updater_protonvpn_email: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# ProtonVPN account email for server list updates
# Type: string
gluetun2_updater_protonvpn_email: ""
gluetun_role_updater_protonvpn_passwordgluetun2_updater_protonvpn_password
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# ProtonVPN account password for server list updates
# Type: string
gluetun_role_updater_protonvpn_password: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md
# ProtonVPN account password for server list updates
# Type: string
gluetun2_updater_protonvpn_password: ""
gluetun_role_publicip_enabledgluetun2_publicip_enabled
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# Enable public IP fetching (on/off)
# Type: string
gluetun_role_publicip_enabled: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# Enable public IP fetching (on/off)
# Type: string
gluetun2_publicip_enabled: ""
gluetun_role_publicip_filegluetun2_publicip_file
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# Path to file for storing public IP
# Type: string
gluetun_role_publicip_file: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# Path to file for storing public IP
# Type: string
gluetun2_publicip_file: ""
gluetun_role_publicip_apigluetun2_publicip_api
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# Public IP API to use (e.g., ipinfo, ip2location)
# Type: string
gluetun_role_publicip_api: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# Public IP API to use (e.g., ipinfo, ip2location)
# Type: string
gluetun2_publicip_api: ""
gluetun_role_publicip_api_tokengluetun2_publicip_api_token
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# API token for public IP service
# Type: string
gluetun_role_publicip_api_token: ""
# Reference: https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/public-ip.md
# API token for public IP service
# Type: string
gluetun2_publicip_api_token: ""
gluetun_role_log_levelgluetun2_log_level
# Log level: debug, info, warning, error
# Type: string
gluetun_role_log_level: ""
# Log level: debug, info, warning, error
# Type: string
gluetun2_log_level: ""
gluetun_role_private_internet_access_openvpn_encryption_presetgluetun2_private_internet_access_openvpn_encryption_preset
# PIA OpenVPN encryption preset: normal, strong, none
# Type: string
gluetun_role_private_internet_access_openvpn_encryption_preset: ""
# PIA OpenVPN encryption preset: normal, strong, none
# Type: string
gluetun2_private_internet_access_openvpn_encryption_preset: ""
gluetun_role_version_informationgluetun2_version_information
# Enable version information logging on startup (on/off)
# Type: string
gluetun_role_version_information: ""
# Enable version information logging on startup (on/off)
# Type: string
gluetun2_version_information: ""
gluetun_role_storage_filepathgluetun2_storage_filepath
# Path to storage file for persisting data
# Type: string
gluetun_role_storage_filepath: ""
# Path to storage file for persisting data
# Type: string
gluetun2_storage_filepath: ""
gluetun_role_pprof_enabledgluetun2_pprof_enabled
# Enable pprof profiling server (on/off)
# Type: string
gluetun_role_pprof_enabled: ""
# Enable pprof profiling server (on/off)
# Type: string
gluetun2_pprof_enabled: ""

Container

gluetun_role_docker_containergluetun2_docker_container
# Type: string
gluetun_role_docker_container: "{{ gluetun_name }}"
# Type: string
gluetun2_docker_container: "{{ gluetun_name }}"

Image

gluetun_role_docker_image_pullgluetun2_docker_image_pull
# Type: bool (true/false)
gluetun_role_docker_image_pull: true
# Type: bool (true/false)
gluetun2_docker_image_pull: true
gluetun_role_docker_image_repogluetun2_docker_image_repo
# Type: string
gluetun_role_docker_image_repo: "qmcgaw/gluetun"
# Type: string
gluetun2_docker_image_repo: "qmcgaw/gluetun"
gluetun_role_docker_image_taggluetun2_docker_image_tag
# Type: string
gluetun_role_docker_image_tag: "v3.41"
# Type: string
gluetun2_docker_image_tag: "v3.41"
gluetun_role_docker_imagegluetun2_docker_image
# Type: string
gluetun_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='gluetun') }}:{{ lookup('role_var', '_docker_image_tag', role='gluetun') }}"
# Type: string
gluetun2_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='gluetun') }}:{{ lookup('role_var', '_docker_image_tag', role='gluetun') }}"
gluetun_role_docker_envs_customgluetun2_docker_envs_custom
# Type: dict
gluetun_role_docker_envs_custom: {}
# Type: dict
gluetun2_docker_envs_custom: {}

Volumes

gluetun_role_docker_volumes_globalgluetun2_docker_volumes_global
# Type: bool (true/false)
gluetun_role_docker_volumes_global: false
# Type: bool (true/false)
gluetun2_docker_volumes_global: false
gluetun_role_docker_volumes_defaultgluetun2_docker_volumes_default
# Type: list
gluetun_role_docker_volumes_default:
  - "{{ gluetun_role_paths_location }}:/gluetun"
# Type: list
gluetun2_docker_volumes_default:
  - "{{ gluetun_role_paths_location }}:/gluetun"
gluetun_role_docker_volumes_customgluetun2_docker_volumes_custom
# Type: list
gluetun_role_docker_volumes_custom: []
# Type: list
gluetun2_docker_volumes_custom: []

Labels

gluetun_role_docker_labels_defaultgluetun2_docker_labels_default
# Type: dict
gluetun_role_docker_labels_default:
  com.centurylinklabs.watchtower.enable: "false"
# Type: dict
gluetun2_docker_labels_default:
  com.centurylinklabs.watchtower.enable: "false"
gluetun_role_docker_labels_customgluetun2_docker_labels_custom
# Type: dict
gluetun_role_docker_labels_custom: {}
# Type: dict
gluetun2_docker_labels_custom: {}

Hostname

gluetun_role_docker_hostnamegluetun2_docker_hostname
# Type: string
gluetun_role_docker_hostname: "{{ gluetun_name }}"
# Type: string
gluetun2_docker_hostname: "{{ gluetun_name }}"

Networks

gluetun_role_docker_networks_aliasgluetun2_docker_networks_alias
# Type: string
gluetun_role_docker_networks_alias: "{{ gluetun_name }}"
# Type: string
gluetun2_docker_networks_alias: "{{ gluetun_name }}"
gluetun_role_docker_networks_defaultgluetun2_docker_networks_default
# Type: list
gluetun_role_docker_networks_default: []
# Type: list
gluetun2_docker_networks_default: []
gluetun_role_docker_networks_customgluetun2_docker_networks_custom
# Type: list
gluetun_role_docker_networks_custom: []
# Type: list
gluetun2_docker_networks_custom: []

Capabilities

gluetun_role_docker_capabilities_defaultgluetun2_docker_capabilities_default
# Type: list
gluetun_role_docker_capabilities_default:
  - NET_ADMIN
# Type: list
gluetun2_docker_capabilities_default:
  - NET_ADMIN
gluetun_role_docker_capabilities_customgluetun2_docker_capabilities_custom
# Type: list
gluetun_role_docker_capabilities_custom: []
# Type: list
gluetun2_docker_capabilities_custom: []

Restart Policy

gluetun_role_docker_restart_policygluetun2_docker_restart_policy
# Type: string
gluetun_role_docker_restart_policy: unless-stopped
# Type: string
gluetun2_docker_restart_policy: unless-stopped

State

gluetun_role_docker_stategluetun2_docker_state
# Type: string
gluetun_role_docker_state: started
# Type: string
gluetun2_docker_state: started

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

gluetun_role_docker_blkio_weightgluetun2_docker_blkio_weight
# Type: int
gluetun_role_docker_blkio_weight:
# Type: int
gluetun2_docker_blkio_weight:
gluetun_role_docker_cpu_periodgluetun2_docker_cpu_period
# Type: int
gluetun_role_docker_cpu_period:
# Type: int
gluetun2_docker_cpu_period:
gluetun_role_docker_cpu_quotagluetun2_docker_cpu_quota
# Type: int
gluetun_role_docker_cpu_quota:
# Type: int
gluetun2_docker_cpu_quota:
gluetun_role_docker_cpu_sharesgluetun2_docker_cpu_shares
# Type: int
gluetun_role_docker_cpu_shares:
# Type: int
gluetun2_docker_cpu_shares:
gluetun_role_docker_cpusgluetun2_docker_cpus
# Type: string
gluetun_role_docker_cpus:
# Type: string
gluetun2_docker_cpus:
gluetun_role_docker_cpuset_cpusgluetun2_docker_cpuset_cpus
# Type: string
gluetun_role_docker_cpuset_cpus:
# Type: string
gluetun2_docker_cpuset_cpus:
gluetun_role_docker_cpuset_memsgluetun2_docker_cpuset_mems
# Type: string
gluetun_role_docker_cpuset_mems:
# Type: string
gluetun2_docker_cpuset_mems:
gluetun_role_docker_kernel_memorygluetun2_docker_kernel_memory
# Type: string
gluetun_role_docker_kernel_memory:
# Type: string
gluetun2_docker_kernel_memory:
gluetun_role_docker_memorygluetun2_docker_memory
# Type: string
gluetun_role_docker_memory:
# Type: string
gluetun2_docker_memory:
gluetun_role_docker_memory_reservationgluetun2_docker_memory_reservation
# Type: string
gluetun_role_docker_memory_reservation:
# Type: string
gluetun2_docker_memory_reservation:
gluetun_role_docker_memory_swapgluetun2_docker_memory_swap
# Type: string
gluetun_role_docker_memory_swap:
# Type: string
gluetun2_docker_memory_swap:
gluetun_role_docker_memory_swappinessgluetun2_docker_memory_swappiness
# Type: int
gluetun_role_docker_memory_swappiness:
# Type: int
gluetun2_docker_memory_swappiness:
gluetun_role_docker_shm_sizegluetun2_docker_shm_size
# Type: string
gluetun_role_docker_shm_size:
# Type: string
gluetun2_docker_shm_size:

Security & Devices

gluetun_role_docker_cap_dropgluetun2_docker_cap_drop
# Type: list
gluetun_role_docker_cap_drop:
# Type: list
gluetun2_docker_cap_drop:
gluetun_role_docker_cgroupns_modegluetun2_docker_cgroupns_mode
# Type: string
gluetun_role_docker_cgroupns_mode:
# Type: string
gluetun2_docker_cgroupns_mode:
gluetun_role_docker_device_cgroup_rulesgluetun2_docker_device_cgroup_rules
# Type: list
gluetun_role_docker_device_cgroup_rules:
# Type: list
gluetun2_docker_device_cgroup_rules:
gluetun_role_docker_device_read_bpsgluetun2_docker_device_read_bps
# Type: list
gluetun_role_docker_device_read_bps:
# Type: list
gluetun2_docker_device_read_bps:
gluetun_role_docker_device_read_iopsgluetun2_docker_device_read_iops
# Type: list
gluetun_role_docker_device_read_iops:
# Type: list
gluetun2_docker_device_read_iops:
gluetun_role_docker_device_requestsgluetun2_docker_device_requests
# Type: list
gluetun_role_docker_device_requests:
# Type: list
gluetun2_docker_device_requests:
gluetun_role_docker_device_write_bpsgluetun2_docker_device_write_bps
# Type: list
gluetun_role_docker_device_write_bps:
# Type: list
gluetun2_docker_device_write_bps:
gluetun_role_docker_device_write_iopsgluetun2_docker_device_write_iops
# Type: list
gluetun_role_docker_device_write_iops:
# Type: list
gluetun2_docker_device_write_iops:
gluetun_role_docker_devicesgluetun2_docker_devices
# Type: list
gluetun_role_docker_devices:
# Type: list
gluetun2_docker_devices:
gluetun_role_docker_devices_defaultgluetun2_docker_devices_default
# Type: string
gluetun_role_docker_devices_default:
# Type: string
gluetun2_docker_devices_default:
gluetun_role_docker_groupsgluetun2_docker_groups
# Type: list
gluetun_role_docker_groups:
# Type: list
gluetun2_docker_groups:
gluetun_role_docker_privilegedgluetun2_docker_privileged
# Type: bool (true/false)
gluetun_role_docker_privileged:
# Type: bool (true/false)
gluetun2_docker_privileged:
gluetun_role_docker_security_optsgluetun2_docker_security_opts
# Type: list
gluetun_role_docker_security_opts:
# Type: list
gluetun2_docker_security_opts:
gluetun_role_docker_usergluetun2_docker_user
# Type: string
gluetun_role_docker_user:
# Type: string
gluetun2_docker_user:
gluetun_role_docker_userns_modegluetun2_docker_userns_mode
# Type: string
gluetun_role_docker_userns_mode:
# Type: string
gluetun2_docker_userns_mode:

Networking

gluetun_role_docker_dns_optsgluetun2_docker_dns_opts
# Type: list
gluetun_role_docker_dns_opts:
# Type: list
gluetun2_docker_dns_opts:
gluetun_role_docker_dns_search_domainsgluetun2_docker_dns_search_domains
# Type: list
gluetun_role_docker_dns_search_domains:
# Type: list
gluetun2_docker_dns_search_domains:
gluetun_role_docker_dns_serversgluetun2_docker_dns_servers
# Type: list
gluetun_role_docker_dns_servers:
# Type: list
gluetun2_docker_dns_servers:
gluetun_role_docker_domainnamegluetun2_docker_domainname
# Type: string
gluetun_role_docker_domainname:
# Type: string
gluetun2_docker_domainname:
gluetun_role_docker_exposed_portsgluetun2_docker_exposed_ports
# Type: list
gluetun_role_docker_exposed_ports:
# Type: list
gluetun2_docker_exposed_ports:
gluetun_role_docker_hostsgluetun2_docker_hosts
# Type: dict
gluetun_role_docker_hosts:
# Type: dict
gluetun2_docker_hosts:
gluetun_role_docker_hosts_use_commongluetun2_docker_hosts_use_common
# Type: bool (true/false)
gluetun_role_docker_hosts_use_common:
# Type: bool (true/false)
gluetun2_docker_hosts_use_common:
gluetun_role_docker_ipc_modegluetun2_docker_ipc_mode
# Type: string
gluetun_role_docker_ipc_mode:
# Type: string
gluetun2_docker_ipc_mode:
gluetun_role_docker_linksgluetun2_docker_links
# Type: list
gluetun_role_docker_links:
# Type: list
gluetun2_docker_links:
gluetun_role_docker_network_modegluetun2_docker_network_mode
# Type: string
gluetun_role_docker_network_mode:
# Type: string
gluetun2_docker_network_mode:
gluetun_role_docker_pid_modegluetun2_docker_pid_mode
# Type: string
gluetun_role_docker_pid_mode:
# Type: string
gluetun2_docker_pid_mode:
gluetun_role_docker_portsgluetun2_docker_ports
# Type: list
gluetun_role_docker_ports:
# Type: list
gluetun2_docker_ports:
gluetun_role_docker_utsgluetun2_docker_uts
# Type: string
gluetun_role_docker_uts:
# Type: string
gluetun2_docker_uts:

Storage

gluetun_role_docker_keep_volumesgluetun2_docker_keep_volumes
# Type: bool (true/false)
gluetun_role_docker_keep_volumes:
# Type: bool (true/false)
gluetun2_docker_keep_volumes:
gluetun_role_docker_mountsgluetun2_docker_mounts
# Type: list
gluetun_role_docker_mounts:
# Type: list
gluetun2_docker_mounts:
gluetun_role_docker_storage_optsgluetun2_docker_storage_opts
# Type: dict
gluetun_role_docker_storage_opts:
# Type: dict
gluetun2_docker_storage_opts:
gluetun_role_docker_tmpfsgluetun2_docker_tmpfs
# Type: list
gluetun_role_docker_tmpfs:
# Type: list
gluetun2_docker_tmpfs:
gluetun_role_docker_volume_drivergluetun2_docker_volume_driver
# Type: string
gluetun_role_docker_volume_driver:
# Type: string
gluetun2_docker_volume_driver:
gluetun_role_docker_volumes_fromgluetun2_docker_volumes_from
# Type: list
gluetun_role_docker_volumes_from:
# Type: list
gluetun2_docker_volumes_from:
gluetun_role_docker_working_dirgluetun2_docker_working_dir
# Type: string
gluetun_role_docker_working_dir:
# Type: string
gluetun2_docker_working_dir:

Monitoring & Lifecycle

gluetun_role_docker_auto_removegluetun2_docker_auto_remove
# Type: bool (true/false)
gluetun_role_docker_auto_remove:
# Type: bool (true/false)
gluetun2_docker_auto_remove:
gluetun_role_docker_cleanupgluetun2_docker_cleanup
# Type: bool (true/false)
gluetun_role_docker_cleanup:
# Type: bool (true/false)
gluetun2_docker_cleanup:
gluetun_role_docker_force_killgluetun2_docker_force_kill
# Type: string
gluetun_role_docker_force_kill:
# Type: string
gluetun2_docker_force_kill:
gluetun_role_docker_healthcheckgluetun2_docker_healthcheck
# Type: dict
gluetun_role_docker_healthcheck:
# Type: dict
gluetun2_docker_healthcheck:
gluetun_role_docker_healthy_wait_timeoutgluetun2_docker_healthy_wait_timeout
# Type: int
gluetun_role_docker_healthy_wait_timeout:
# Type: int
gluetun2_docker_healthy_wait_timeout:
gluetun_role_docker_initgluetun2_docker_init
# Type: bool (true/false)
gluetun_role_docker_init:
# Type: bool (true/false)
gluetun2_docker_init:
gluetun_role_docker_kill_signalgluetun2_docker_kill_signal
# Type: string
gluetun_role_docker_kill_signal:
# Type: string
gluetun2_docker_kill_signal:
gluetun_role_docker_log_drivergluetun2_docker_log_driver
# Type: string
gluetun_role_docker_log_driver:
# Type: string
gluetun2_docker_log_driver:
gluetun_role_docker_log_optionsgluetun2_docker_log_options
# Type: dict
gluetun_role_docker_log_options:
# Type: dict
gluetun2_docker_log_options:
gluetun_role_docker_oom_killergluetun2_docker_oom_killer
# Type: bool (true/false)
gluetun_role_docker_oom_killer:
# Type: bool (true/false)
gluetun2_docker_oom_killer:
gluetun_role_docker_oom_score_adjgluetun2_docker_oom_score_adj
# Type: int
gluetun_role_docker_oom_score_adj:
# Type: int
gluetun2_docker_oom_score_adj:
gluetun_role_docker_output_logsgluetun2_docker_output_logs
# Type: bool (true/false)
gluetun_role_docker_output_logs:
# Type: bool (true/false)
gluetun2_docker_output_logs:
gluetun_role_docker_pausedgluetun2_docker_paused
# Type: bool (true/false)
gluetun_role_docker_paused:
# Type: bool (true/false)
gluetun2_docker_paused:
gluetun_role_docker_recreategluetun2_docker_recreate
# Type: bool (true/false)
gluetun_role_docker_recreate:
# Type: bool (true/false)
gluetun2_docker_recreate:
gluetun_role_docker_restart_retriesgluetun2_docker_restart_retries
# Type: int
gluetun_role_docker_restart_retries:
# Type: int
gluetun2_docker_restart_retries:
gluetun_role_docker_stop_timeoutgluetun2_docker_stop_timeout
# Type: int
gluetun_role_docker_stop_timeout:
# Type: int
gluetun2_docker_stop_timeout:

Other Options

gluetun_role_docker_cgroup_parentgluetun2_docker_cgroup_parent
# Type: string
gluetun_role_docker_cgroup_parent:
# Type: string
gluetun2_docker_cgroup_parent:
gluetun_role_docker_commandsgluetun2_docker_commands
# Type: list
gluetun_role_docker_commands:
# Type: list
gluetun2_docker_commands:
gluetun_role_docker_create_timeoutgluetun2_docker_create_timeout
# Type: int
gluetun_role_docker_create_timeout:
# Type: int
gluetun2_docker_create_timeout:
gluetun_role_docker_entrypointgluetun2_docker_entrypoint
# Type: string
gluetun_role_docker_entrypoint:
# Type: string
gluetun2_docker_entrypoint:
gluetun_role_docker_env_filegluetun2_docker_env_file
# Type: string
gluetun_role_docker_env_file:
# Type: string
gluetun2_docker_env_file:
gluetun_role_docker_labels_use_commongluetun2_docker_labels_use_common
# Type: bool (true/false)
gluetun_role_docker_labels_use_common:
# Type: bool (true/false)
gluetun2_docker_labels_use_common:
gluetun_role_docker_read_onlygluetun2_docker_read_only
# Type: bool (true/false)
gluetun_role_docker_read_only:
# Type: bool (true/false)
gluetun2_docker_read_only:
gluetun_role_docker_runtimegluetun2_docker_runtime
# Type: string
gluetun_role_docker_runtime:
# Type: string
gluetun2_docker_runtime:
gluetun_role_docker_sysctlsgluetun2_docker_sysctls
# Type: list
gluetun_role_docker_sysctls:
# Type: list
gluetun2_docker_sysctls:
gluetun_role_docker_ulimitsgluetun2_docker_ulimits
# Type: list
gluetun_role_docker_ulimits:
# Type: list
gluetun2_docker_ulimits:
gluetun_role_autoheal_enabledgluetun2_autoheal_enabled
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
gluetun_role_autoheal_enabled: true
# Enable or disable Autoheal monitoring for containers created when deploying
# Type: bool (true/false)
gluetun2_autoheal_enabled: true
gluetun_role_depends_ongluetun2_depends_on
# List of container dependencies that must be running before containers start
# Type: string
gluetun_role_depends_on: ""
# List of container dependencies that must be running before containers start
# Type: string
gluetun2_depends_on: ""
gluetun_role_depends_on_delaygluetun2_depends_on_delay
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
gluetun_role_depends_on_delay: "0"
# Delay in seconds before starting containers after dependencies are ready
# Type: string (quoted number)
gluetun2_depends_on_delay: "0"
gluetun_role_depends_on_healthchecksgluetun2_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
gluetun_role_depends_on_healthchecks:
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
gluetun2_depends_on_healthchecks:
gluetun_role_diun_enabledgluetun2_diun_enabled
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
gluetun_role_diun_enabled: true
# Enable or disable Diun update notifications for containers created when deploying
# Type: bool (true/false)
gluetun2_diun_enabled: true
gluetun_role_docker_controllergluetun2_docker_controller
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
gluetun_role_docker_controller: true
# Enable or disable Saltbox Docker Controller management for containers
# Type: bool (true/false)
gluetun2_docker_controller: true
gluetun_role_docker_image_repogluetun2_docker_image_repo
# Type: string
gluetun_role_docker_image_repo:
# Type: string
gluetun2_docker_image_repo:
gluetun_role_docker_image_taggluetun2_docker_image_tag
# Type: string
gluetun_role_docker_image_tag:
# Type: string
gluetun2_docker_image_tag:
gluetun_role_docker_volumes_downloadgluetun2_docker_volumes_download
# Type: bool (true/false)
gluetun_role_docker_volumes_download:
# Type: bool (true/false)
gluetun2_docker_volumes_download: