All apps · 0 apps

Gluetun-Full

Docker app from FiddlyRumpus' Repository

Overview

Gluetun - Lightweight swiss-army-knife-like VPN client to multiple VPN service providers. 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. 'Gluetun-Full' is an attempt to: include ALL of the published paths, ports, & variables available for Gluetun (set to their defaults) from the upstream project, repo, & wiki; to keep them ALL up-to-date as much as possible; and to include Gluetun-Wiki URLs for each config item; all presented in a useful template for the Unraid community.

Readme

View on GitHub

Gluetun VPN client

Lightweight swiss-army-knife-like VPN client to multiple VPN service providers

⚠️ This and gluetun-wiki are the only websites for Gluetun, other websites claiming to be official are scams ⚠️

🗯️ this repository will be migrated to github.com/passteque/gluetun on 2026-05-21, which is a Github organization under my sole control, so don't get alarmed if you get redirected in the coming days 😉 Reason being migrating Github sponsors to the Open source collective due to my personal situation, basically annoying paperwork. On the plus side, it will be more transparent and funds donated will only be used for the project. The Docker image names will remain the same.

Title image

Last release Last Docker tag GitHub last release date Commits since release

Code size GitHub repo size Go version

Quick links

Setup
Features
Problem?
- Check the Wiki common errors and faq
- Start a discussion
- Fix the Unraid template
Suggestion?
- Create an issue
Happy?
- Sponsor me on github.com/sponsors/qdm12
- Donate to paypal.me/qmcgaw
- Drop me an email
Want to add a VPN provider? check the development page and add a provider page
Video:
Substack Console interview

Features

Based on Alpine 3.23 for a small Docker image of 43.1MB
Supports: AirVPN, Cyberghost, ExpressVPN, FastestVPN, Giganews, HideMyAss, IPVanish, IVPN, Mullvad (Wireguard only), NordVPN, Perfect Privacy, Privado, Private Internet Access, PrivateVPN, ProtonVPN, PureVPN, SlickVPN, Surfshark, TorGuard, VPNSecure.me, VPNUnlimited, Vyprvpn, Windscribe servers
Supports OpenVPN for all providers listed
Supports Wireguard both kernelspace and userspace
- For AirVPN, FastestVPN, Ivpn, Mullvad, NordVPN, Perfect privacy, ProtonVPN, Surfshark and Windscribe
- For Cyberghost, Private Internet Access, PrivateVPN, PureVPN, Torguard, VPN Unlimited and VyprVPN using the custom provider
- For custom Wireguard configurations using the custom provider
- More in progress, see #134
Supports AmneziaWG only with the custom provider for now
DNS over TLS baked in with service provider(s) of your choice
DNS fine blocking of malicious/ads hostnames and IP addresses, with live update every 24 hours
Choose the vpn network protocol, udp or tcp
Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices
Built in Shadowsocks proxy server (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
Built in Socks5 proxy server (tunnels TCP+UDP) - partial credits to @angelakis and @adjscent
Built in HTTP proxy (tunnels HTTP and HTTPS through TCP)
Connect other containers to it
Connect LAN devices to it
Compatible with amd64, i686 (32 bit), ARM 64 bit, ARM 32 bit v6 and v7, and even ppc64le 🎆
Custom VPN server side port forwarding for Perfect Privacy, Private Internet Access, PrivateVPN and ProtonVPN
Possibility of split horizon DNS by selecting multiple DNS over TLS providers
Can work as a Kubernetes sidecar container, thanks @rorph

Setup

🎉 There are now instructions specific to each VPN provider with examples to help you get started as quickly as possible!

Go to the Wiki!

🐛 Found a bug in the Wiki?!

Here's a docker-compose.yml for the laziest:

---
services:
  gluetun:
    image: qmcgaw/gluetun
    # container_name: gluetun
    # line above must be uncommented to allow external containers to connect.
    # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md#external-container-to-gluetun
    cap_add:
      - NET_ADMIN
    devices:
      - /dev/net/tun:/dev/net/tun
    ports:
      - 8888:8888/tcp # HTTP proxy
      - 8388:8388/tcp # Shadowsocks
      - 8388:8388/udp # Shadowsocks
    volumes:
      - /yourpath:/gluetun
    environment:
      # See https://github.com/qdm12/gluetun-wiki/tree/main/setup#setup
      - VPN_SERVICE_PROVIDER=ivpn
      - VPN_TYPE=openvpn
      # OpenVPN:
      - OPENVPN_USER=
      - OPENVPN_PASSWORD=
      # Wireguard:
      # - WIREGUARD_PRIVATE_KEY=wOEI9rqqbDwnN8/Bpp22sVz48T71vJ4fYmFWujulwUU=
      # - WIREGUARD_ADDRESSES=10.64.222.21/32
      # Timezone for accurate log times
      - TZ=
      # Server list updater
      # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list
      - UPDATER_PERIOD=

🆕 Image also available as ghcr.io/qdm12/gluetun

Fun graphs

License

Install Gluetun-Full on Unraid in a few clicks.

Find Gluetun-Full in Community Apps on your Unraid server, review the template, and click Install. Unraid handles the Docker app or plugin setup from the published template.

Open the Apps tab on your Unraid server Search Community Apps for Gluetun-Full Review the template variables and paths Click Install

Explore Unraid OS

Related apps

Explore more like this

Explore all

VPN apps Privacy apps Security

Links

Projectgithub.com Supportforums.unraid.net Docker Hubhub.docker.com Templateraw.githubusercontent.com

Details

Repository

qmcgaw/gluetun:latest

Registry

https://hub.docker.com/r/qmcgaw/gluetun

Last Updated2026-06-11

First Seen2021-07-24

Runtime arguments

Web UI: http://[IP]:[PORT:8000]
Network: bridge
Shell: sh
Privileged: false
Extra Params: --cap-add=NET_ADMIN --device /dev/net/tun

Template configuration

Host PathPathrw

Target: /gluetun
Default: /mnt/cache/appdata/gluetun
Value: /mnt/cache/appdata/gluetun

VPN - Service ProviderVariable

REQ: Specify a supported VPN provider to use (Valid VPN provider) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn.md

Target: VPN_SERVICE_PROVIDER
Default: airvpn|custom|cyberghost|expressvpn|fastestvpn|giganews|hidemyass|ipvanish|ivpn|mullvad|nordvpn|perfect privacy|privado|private internet access|privatevpn|protonvpn|purevpn|slickvpn|surfshark|torguard|vpnsecure|vpn unlimited|vyprvpn|windscribe
Value: private internet access

VPN - TypeVariable

REQ: VPN protocol to use. Not all providers support Wireguard. (openvpn or wireguard) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn.md

Target: VPN_TYPE
Default: openvpn|wireguard
Value: openvpn

VPN - InterfaceVariable

REQ: Specify a custom network interface name to use (Any interface name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn.md

Target: VPN_INTERFACE
Default: tun0
Value: tun0

VPN - Up CommandVariable

OPT: Command to run when the VPN connection goes up. You can use the following template variables if needed: {{VPN_INTERFACE}} (Shell command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn.md

Target: VPN_UP_COMMAND

VPN - Down CommandVariable

OPT: Command to run when the VPN connection goes down. You can use the following template variables if needed: {{VPN_INTERFACE}} (Shell command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/vpn.md

Target: VPN_DOWN_COMMAND

OpenVPN - UserVariable

REQ: OpenVPN username . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_USER

OpenVPN - PasswordVariable

REQ: OpenVPN password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_PASSWORD

OpenVPN - ProtocolVariable

OPT: Network protocol to use, only valid for OpenVPN (udp or tcp) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_PROTOCOL
Default: udp|tcp
Value: udp

OpenVPN - VersionVariable

OPT: Set the OpenVPN version to run (2.5 or 2.6) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_VERSION
Default: 2.6|2.5
Value: 2.6

OpenVPN - Endpoint IPVariable

OPT: Specify a generally optional target VPN server IP address to use (valid IP address) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_ENDPOINT_IP

OpenVPN - Endpoint PortVariable

OPT: Specify a generally optional target VPN server port number to use (valid port number) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_ENDPOINT_PORT

OpenVPN - VerbosityVariable

OPT: OpenVPN verbosity level (0 to 6). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_VERBOSITY
Default: 0|1|2|3|4|5|6
Value: 1

OpenVPN - FlagsVariable

OPT: Space delimited OpenVPN flags to pass to openvpn (Openvpn flags) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_FLAGS

OpenVPN - RootVariable

OPT: Run OpenVPN as root (yes or no) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_ROOT
Default: no|yes
Value: no

OpenVPN - CiphersVariable

OPT: Specify a custom cipher to use. It will also set ncp-disable if using AES GCM for PIA (i.e. aes-256-gcm) . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_CIPHERS

OpenVPN - AuthVariable

OPT: Specify a custom auth algorithm to use (i.e. sha256) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_AUTH

OpenVPN - MSS FixVariable

OPT: Set the MSS fix parameter. Set to 0 to use the defaults. (0 to 9999) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_MSSFIX
Default: 0
Value: 0

OpenVPN - CertVariable

OPT: OpenVPN certificate content ([base64 part only](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/openvpn-client-certificate.md)) (base64 PEM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_CERT

OpenVPN - KeyVariable

OPT: OpenVPN key ([base64 part only](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/openvpn-client-encrypted-key.md)) (base64 PEM). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_KEY

OpenVPN - Encrypted KeyVariable

OPT: OpenVPN encrypted key ([base64 part only](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/openvpn-client-key.md)) (base64 PEM) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_ENCRYPTED_KEY

OpenVPN - Key PassphraseVariable

OPT: Specify a key passphrase to decrypt an encrypted key . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_KEY_PASSPHRASE

OpenVPN - Process UserVariable

OPT: Specify a user to run the OpenVPN subprocess (Valid OS user) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_PROCESS_USER
Default: root
Value: root

OpenVPN - Custom ConfigVariable

OPT: Specify a custom OpenVPN configuration file to use for [the custom VPN provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md). (Empty or path to file) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/openvpn.md

Target: OPENVPN_CUSTOM_CONFIG

Wireguard - Private KeyVariable

REQ: Wireguard client private key to use. This is usually always needed. (Valid base 58 Wireguard key) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_PRIVATE_KEY

Wireguard - AddressesVariable

REQ: This is usually needed. (Valid IP network interface address in the format xx.xx.xx.xx/xx) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_ADDRESSES

Wireguard - Public KeyVariable

REQ/OPT: Wireguard server public key to use. This may or may not be needed. (Valid base 58 Wireguard key) . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_PUBLIC_KEY

Wireguard - Endpoint IPVariable

OPT/REQ: Specify a generally optional target VPN server IP address to use (Valid IP address) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_ENPOINT_IP

Wireguard - Endpoint PortVariable

OPT/REQ: Specify a generally optional target VPN server port number to use (Valid port number) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_ENPOINT_PORT

Wireguard - Preshared KeyVariable

OPT: Wireguard pre-shared key (Base64 pre-shared key) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_PRESHARED_KEY

Wireguard - Allowed IPsVariable

OPT: Wireguard peer allowed ips (CSV of IP address ranges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_ALLOWED_IPS
Default: 0.0.0.0/0,::/0
Value: 0.0.0.0/0,::/0

Wireguard - ImplementationVariable

Wireguard implementation to use (auto, kernelspace or userspace) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_IMPLEMENTATION
Default: auto|kernelspace|userspace
Value: auto

Wireguard - MTUVariable

OPT: Wireguard MTU (Any positive value generally up to 1440) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_MTU
Default: 1320
Value: 1320

Wireguard - Persistant Keepalive IntervalVariable

OPT: Wireguard persistent keepalive interval (Any duration, for example 25s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/wireguard.md

Target: WIREGUARD_PERSISTENT_KEEPALIVE_INTERVAL

AmneziaWG - Private KeyVariable

REQ: Amneziawg client private key to use. This is usually always needed. (Valid base 58 Amneziawg key) . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_PRIVATE_KEY

AmneziaWG - AddressesVariable

Target: AMNEZIAWG_ADDRESSES

AmneziaWG - Public KeyVariable

REQ/OPT: Amneziawg server public key to use. This may or may not be needed. (Valid base 58 Amneziawg key) . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_PUBLIC_KEY

AmneziaWG - Endpoint IPVariable

Target: AMNEZIAWG_ENDPOINT_IP

AmneziaWG - Endpoint PortVariable

Target: AMNEZIAWG_ENDPOINT_PORT

AmneziaWG - Preshared KeyVariable

OPT: Amneziawg pre-shared key (Base64 pre-shared key) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_PRESHARED_KEY

AmneziaWG - Allowed IPsVariable

OPT: Amneziawg peer allowed ips (CSV of IP address ranges) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_ALLOWED_IPS
Default: 0.0.0.0/0,::/0
Value: 0.0.0.0/0,::/0

AmneziaWG - MTUVariable

OPT: Amneziawg MTU (Any positive value generally up to 1440, probably lower with Amneziawg) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_MTU
Default: 1320
Value: 1320

AmneziaWG - Persistant Keepalive IntervalVariable

OPT: Amneziawg persistent keepalive interval (Any duration, for example 25s) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_PERSISTENT_KEEPALIVE_INTERVAL

AmneziaWG - Junk CountVariable

OPT: Number of junk packets following I1-I5 and sent before the actual handshake initiation (Any positive integer) . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_JC
Default: 0
Value: 0

AmneziaWG - Junk MinVariable

OPT: Minimum size in bytes of the random junk data prefixed to the handshake packet (Any positive integer and must be less than or equal to AMNEZIAWG_JMAX) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_JMIN
Default: 0
Value: 0

AmneziaWG - Junk MaxVariable

OPT: Maximum size in bytes of the random junk data prefixed to the handshake packet (Any positive integer and must be greater than or equal to AMNEZIAWG_JMIN) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_JMAX
Default: 0
Value: 0

AmneziaWG - S1Variable

OPT: Random bytes to pad the handshake initiation packets (Any positive integer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_S1
Default: 0
Value: 0

AmneziaWG - S2Variable

OPT: Random bytes to pad the handshake response packets (Any positive integer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_S2
Default: 0
Value: 0

AmneziaWG - S3Variable

OPT: Random bytes to pad the handshake cookie reply packets (Any positive integer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_S3
Default: 0
Value: 0

AmneziaWG - S4Variable

OPT: Random bytes to pad the encrypted transport data packets (Any positive integer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_S4
Default: 0
Value: 0

AmneziaWG - H1Variable

OPT: header range of the handshake initiation message (n or range n-m, with values from 0 to 4294967295) . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_H1
Default: 0
Value: 0

AmneziaWG - H2Variable

OPT: header range of the handshake response message (n or range n-m, with values from 0 to 4294967295) . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_H2
Default: 0
Value: 0

AmneziaWG - H3Variable

OPT: header range of the handshake cookie reply message (n or range n-m, with values from 0 to 4294967295) . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_H3
Default: 0
Value: 0

AmneziaWG - H4Variable

OPT: header range of the transport data message (n or range n-m, with values from 0 to 4294967295) . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_H4
Default: 0
Value: 0

AmneziaWG - I1Variable

OPT: See [custom signature packets](https://github.com/amnezia-vpn/amneziawg-go?tab=readme-ov-file#custom-signature-packets) . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/amneziawg.md

Target: AMNEZIAWG_I1

AmneziaWG - I2Variable

Target: AMNEZIAWG_I2

AmneziaWG - I3Variable

Target: AMNEZIAWG_I3

AmneziaWG - I4Variable

Target: AMNEZIAWG_I4

AmneziaWG - I5Variable

Target: AMNEZIAWG_I5

Port ForwardingVariable

OPT: Enable custom port forwarding code for supported providers (off or on) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md

Target: VPN_PORT_FORWARDING
Default: off|on
Value: off

Port Forwarding - ProviderVariable

OPT: Choose the custom port forwarding code to use. This is useful when using the custom provider with Wireguard. For PIA, make sure you set SERVER_NAMES. (private-internet-access, perfect-privacy, privatevpn, protonvpn) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md

Target: VPN_PORT_FORWARDING_PROVIDER
Default: private internet access|perfect privacy|privatevpn|protonvpn

Port Forwarding - Ports CountVariable

OPT: Number of TCP+UDP ports to forward. Can be up to 5 for ProtonVPN. (Depends on VPN provider) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md

Target: VPN_PORT_FORWARDING_PORTS_COUNT
Default: 1|2|3|4|5
Value: 1

Port Forwarding - Status FileVariable

OPT: File path to use for writing the forwarded port obtained. (Valid filepath) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md

Target: VPN_PORT_FORWARDING_STATUS_FILE
Default: /gluetun/forwarded_port
Value: /gluetun/forwarded_port

Port Forwarding - Listening PortsVariable

OPT: Port redirections to redirect incoming traffic to. Do not use with torrent clients. Specify 0 or N ports for VPN_PORT_FORWARDING_PORTS_COUNT=N (Comma separated list of port numbers) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md

Target: VPN_PORT_FORWARDING_LISTENING_PORTS

Port Forwarding - Up CommandVariable

OPT: Command to run when port forwarding has finished setting up. (Shell command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md

Target: VPN_PORT_FORWARDING_UP_COMMAND

Port Forwarding - Down CommandVariable

OPT: Command to run when port forwarding has finished tearing down. (Shell command) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/port-forwarding.md

Target: VPN_PORT_FORWARDING_DOWN_COMMAND

Providers - Server CountriesVariable

OPT: Comma separated list of countries (USED BY: airvpn, cyberghost, expressvpn, fastestvpn, hidemyass, ipvanish, ivpn, mullvad, nordvpn, privado, privatevpn, protonvpn, purevpn, slickvpn, surfshark, torguard, vpn-unlimited) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers

Target: SERVER_COUNTRIES

Providers - Server RegionsVariable

OPT: Comma separated list of regions (USED BY: airvpn, giganews, hidemyass, nordvpn, privado, private-internet-access, protonvpn, purevpn, slickvpn, surfshark, vpn-secure, vpn-unlimited, vyprvpn, windscribe) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers

Target: SERVER_REGIONS

Providers - Server CitiesVariable

OPT: Comma separated list of cities (USED BY: airvpn, expressvpn, fastestvpn, hidemyass, ipvanish, ivpn, mullvad, nordvpn, perfect-privacy, privado, privatevpn, protonvpn, purevpn, slickvpn, surfshark, torguard, vpn-secure, vpn-unlimited, windscribe) . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers

Target: SERVER_CITIES

Providers - Server NamesVariable

OPT: Comma separated list of server names (USED BY: airvpn, private-internet-access) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers

Target: SERVER_NAMES

Providers - Server HostnamesVariable

OPT: Comma separated list of server hostnames. Beware this is the narrowest filter, so if you set this to a single hostname and this hostname disappears from the Gluetun servers data due to an update, your container will no longer work until this filter is changed. I would suggest avoiding it unless you know this reliability risk. (USED BY: all EXCEPT perfect privacy) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers

Target: SERVER_HOSTNAMES

Providers - ISPVariable

OPT: Comma separated list of ISPs (USED BY: ivpn, mullvad) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers

Target: ISP

Providers - Owned OnlyVariable

OPT: If the VPN server is owned by Mullvad. It defaults to no, meaning it includes all servers. It can be set to yes. (USED BY: mullvad) . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/mullvad.md

Target: OWNED_ONLY
Default: no|yes
Value: no

Providers - Server CategoriesVariable

OPT: Comma separated list of server categories (USED BY: nordvpn) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/nordvpn.md

Target: SERVER_CATEGORIES

Providers - Port Forward OnlyVariable

OPT: Set to true to select servers with port forwarding only. It defaults to false (USED BY: private-internet-access) (true or false) . . . . . . . Filter only port-forwarding enabled (aka p2p) servers by setting it to on. It defaults to off. (USED BY: protonvpn) (off or on) . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers

Target: PORT_FORWARD_ONLY
Default: off|on|true|false
Value: false

Providers - Private Internet Access OpenVPN Encryption PresetVariable

OPT: Encryption preset, defaulting to strong, which can be set to normal or strong (USED BY: private-internet-access) . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/private-internet-access.md

Target: PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET
Default: strong|normal
Value: strong

Providers - Free OnlyVariable

OPT: Filter only free tier servers by setting it to on. It defaults to off (USED BY: protonvpn) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/protonvpn.md

Target: FREE_ONLY
Default: off|on
Value: off

Providers - Stream OnlyVariable

OPT: Filter only streaming servers by setting it to on. It defaults to off (USED BY: protonvpn) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/protonvpn.md

Target: STREAM_ONLY
Default: off|on
Value: off

Providers - Secure Core OnlyVariable

OPT: Filter only secure core servers by setting it to on. It defaults to off. (USED BY: protonvpn) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/protonvpn.md

Target: SECURE_CORE_ONLY
Default: off|on
Value: off

Providers - TOR OnlyVariable

OPT: Filter only TOR servers by setting it to on. It defaults to off (USED BY: protonvpn) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/protonvpn.md

Target: TOR_ONLY
Default: off|on
Value: off

Providers - Premium OnlyVariable

OPT: yes or no (USED BY: vpn-secure) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/tree/main/setup/providers/vpn-secure.md

Target: PREMIUM_ONLY
Default: no|yes

Firewall - VPN Input PortsVariable

OPT: Comma separated list of ports to allow from the VPN server side (i.e. 1000,8080) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md

Target: FIREWALL_VPN_INPUT_PORTS

Firewall - Input PortsVariable

OPT: Comma separated list of ports to allow through the default interface. This seems needed for Kubernetes sidecars. (i.e. 1000,8000) . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md

Target: FIREWALL_INPUT_PORTS

Firewall - iptables Log LevelVariable

OPT: Sets the log level for iptables commands. Use debug for detailed logging. (debug, info, warn, error) . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md

Target: FIREWALL_IPTABLES_LOG_LEVEL

Firewall - Outbound SubnetsVariable

OPT: Comma separated subnets that Gluetun and the containers sharing its network stack are allowed to access. This involves firewall and routing modifications. (i.e. 192.168.1.0/24,192.168.10.121/32,10.0.0.5/28) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/firewall.md

Target: FIREWALL_OUTBOUND_SUBNETS

Health Check - Target AddressesVariable

OPT: Addresses to TCP+TLS dial on connection establishment and then every 5 minutes. Extra addresses are used as fallbacks. . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/healthcheck.md

Target: HEALTH_TARGET_ADDRESSES
Default: cloudflare.com:443,github.com:443
Value: cloudflare.com:443,github.com:443

Health Check - ICMP Target IPsVariable

OPT: Addresses to ICMP ping every minute after connection. Extra addresses are used as fallbacks. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/healthcheck.md

Target: HEALTH_ICMP_TARGET_IPS
Default: 1.1.1.1,8.8.8.8
Value: 1.1.1.1,8.8.8.8

Health Check - Server AddressVariable

OPT: Internal health check server listening address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/healthcheck.md

Target: HEALTH_SERVER_ADDRESS
Default: 127.0.0.1:9999
Value: 127.0.0.1:9999

Health Check - Restart VPNVariable

OPT: Auto healing feature. I highly suggest keeping this on. You can keep it off to debug why your connection goes unstable. . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/healthcheck.md

Target: HEALTH_RESTART_VPN
Default: on|off
Value: on

DNS - Upstream Resolver TypeVariable

OPT: How to connect to the upstream DNS servers. dot means DNS over TLS, doh means DNS over HTTPS, plain means plain UDP DNS. (dot, doh or plain) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_UPSTREAM_RESOLVER_TYPE
Default: dot|doh|plain
Value: dot

DNS - Upstream ResolversVariable

Comma delimited list of DNS over TLS providers (cira family, cira private, cira protected, cleanbrowsing adult, cleanbrowsing family, cleanbrowsing security, cloudflare, cloudflare family, cloudflare security, google, libredns, opendns, quad9, quad9 secured, quad9 unsecured, quadrant) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_UPSTREAM_RESOLVERS
Default: cloudflare,google
Value: cloudflare,google

DNS - CachingVariable

OPT: DNS caching (on,off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_CACHING
Default: on|off
Value: on

DNS - Upstream IPv6Variable

OPT: DNS IPv6 resolution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_UPSTREAM_IPV6
Default: off|on
Value: off

DNS - Block IPsVariable

OPT: Comma separated list of IP addresses to not resolve public domains to. (Any valid IP address) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_BLOCK_IPS

DNS - Block IP PrefixesVariable

OPT: Comma separated list of CIDRs to not resolve public domains to. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_BLOCK_IP_PREFIXES

DNS - Rebinding Protection Protection Exempt HostnamesVariable

OPT: Public domain names to exclude from DNS rebinding protection (Comma separated list of public domain names) . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_REBINDING_PROTECTION_EXEMPT_HOSTNAMES

DNS - Update PeriodVariable

OPT: Period to update block lists and cryptographic files and restart Unbound. Set to 0 to deactivate updates. (i.e. 0, 30s, 5m, 24h) . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_UPDATE_PERIOD
Default: 24h
Value: 24h

DNS - Block MaliciousVariable

OPT: Block malicious hostnames and IPs (on, off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: BLOCK_MALICIOUS
Default: on|off
Value: on

DNS - Block AdsVariable

OPT: Block ads hostnames and IPs (on, off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: BLOCK_ADS
Default: off|on
Value: off

DNS - Unblock HostnamesVariable

OPT: Comma separated list of domain names to leave unblocked from the filtering (i.e. domain1.com,x.domain2.co.uk) . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_UNBLOCK_HOSTNAMES

DNS - Upstream Plain AddressesVariable

OPT: (Warning: prefer NOT using this) If set, the internal DNS server will forward queries to the addresses specified over plaintext. Ideally do NOT use the VPN provider DNS, see why [here](https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md#warning-on-dns_upstream_plain_addresses). If you set this to a private IP address on your Docker bridge network or your LAN, your DNS queries will leak out of the VPN tunnel! (Comma separated list of ip:port addresses) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/dns.md

Target: DNS_UPSTREAM_PLAIN_ADDRESSES

HTTP ProxyVariable

OPT: Enable the internal HTTP proxy (on,off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md

Target: HTTPPROXY
Default: off|on
Value: off

HTTP Proxy - LogVariable

OPT: Logs every tunnel requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md

Target: HTTPPROXY_LOG
Default: off|on
Value: off

HTTP Proxy - Listening AddressPorttcp

OPT: Internal listening address for the HTTP proxy (A listening address) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md

Target: 8888
Default: :8888

HTTP Proxy - UserVariable

OPT: Username to use to connect to the HTTP proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md

Target: HTTPPROXY_USER

HTTP Proxy - PasswordVariable

OPT: Password to use to connect to the HTTP proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md

Target: HTTPPROXY_PASSWORD

HTTP Proxy - StealthVariable

OPT: Stealth mode means HTTP proxy headers are not added to your requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/http-proxy.md

Target: HTTPPROXY_STEALTH
Default: off|on
Value: off

ShadowsocksVariable

OPT: Enable the internal Shadowsocks proxy (on,off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md

Target: SHADOWSOCKS
Default: off|on
Value: off

Shadowsocks - LogVariable

OPT: Enable Shadowsocks logging (on,off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md

Target: SHADOWSOCKS_LOG
Default: off|on
Value: off

Shadowsocks - Listening AddressPorttcp

OPT: Internal listening address for Shadowsocks (Listening address) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md

Target: 8388
Default: :8388

Shadowsocks - PasswordVariable

OPT: Password to use to connect to Shadowsocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md

Target: SHADOWSOCKS_PASSWORD

Shadowsocks - CipherVariable

OPT: AEAD Cipher to use for Shadowsocks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/shadowsocks.md

Target: SHADOWSOCKS_CIPHER
Default: chacha20-ietf-poly1305|aes-128-gcm|aes-256-gcm
Value: chacha20-ietf-poly1305

Control Server - AddressPorttcp

OPT: Listening address for the HTTP control server (Valid listening address) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md

Target: 8000
Default: :8000

Control Server - LogVariable

OPT: Enable logging of HTTP requests (on or off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md

Target: HTTP_CONTROL_SERVER_LOG
Default: on|off
Value: on

Control Server - Auth Config FilepathVariable

OPT: Path to a TOML file containing authentication configuration (Valid path) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/control-server.md

Target: HTTP_CONTROL_SERVER_AUTH_CONFIG_FILEPATH

Control Server - Auth Default RoleVariable

ADV: For the lazies not willing to setup a configuration file (Valid JSON string) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md

Target: HTTP_CONTROL_SERVER_AUTH_DEFAULT_ROLE
Default: {"auth":"basic","username":"controlserver","password":"controlserver"}
Value: {"auth":"basic","username":"controlserver","password":"controlserver"}

Updater - Prefer Direct DownloadVariable

OPT: Whether to prefer direct download of servers data from [gluetun-servers](https://github.com/qdm12/gluetun-servers/tree/main/pkg/servers), instead of using the Gluetun code to fetch, parse and process servers data. This is notably faster and more reliable, but defaults to no to avoid breaking compatibility. (yes or no) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md

Target: UPDATER_PREFER_DIRECT_DOWNLOAD
Default: no|yes
Value: no

Updater - PeriodVariable

OPT: Period to update the VPN servers data in memory and to /gluetun/servers/. Set to 0 to disable. This does a burst of DNS over HTTPs requests, which may be blocked if you set BLOCK_MALICIOUS=on for example. (Valid duration string such as 480h) . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md

Target: UPDATER_PERIOD
Default: 0|360h|480h
Value: 0

Updater - Min RatioVariable

OPT: Ratio of servers to be found for the update to succeed, compared to the servers already built in the program (Ratio between 0 (excluded) and 1) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md

Target: UPDATER_MIN_RATIO
Default: 0.1|0.2|0.3|0.4|0.5|0.6|0.7|0.8|0.9|1
Value: 0.8

Updater - Service ProvidersVariable

OPT: List of providers to update servers data for, when the updater triggers periodically. If left empty, it defaults to the current VPN provider used at start. (Any valid VPN provider name) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md

Target: UPDATER_VPN_SERVICE_PROVIDERS

Updater - ProtonVPN EmailVariable

OPT: If you need paid servers data, you must use a paid account. Otherwise I recommend creating a free throwaway account for this. (Your Proton email) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md

Target: UPDATER_PROTONVPN_EMAIL

Updater - ProtonVPN PasswordVariable

OPT: If you need paid servers data, you must use a paid account. Otherwise I recommend creating a free throwaway account for this. (Your Proton password) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/updater.md

Target: UPDATER_PROTONVPN_PASSWORD

Others - Log LevelVariable

OPT: Set the logging level verbosity (debug,info,warn,error) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: LOG_LEVEL
Default: info|debug|warn|error
Value: info

Others - TimezoneVariable

OPT: Specify a [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) to use to have correct log times (i.e. Europe/London) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: TZ

Others - PUIDVariable

OPT: User ID to run as non root and for ownership of files written (99) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: PUID
Default: 99
Value: 99

Others - PGIDVariable

OPT: Group ID to run as non root and for ownership of files written (100) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: PGID
Default: 100
Value: 100

Others - Public IP EnabledVariable

OPT: Check for public IP address information on VPN connection (true,false) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: PUBLICIP_ENABLED
Default: true|false
Value: true

Others - Public IP APIVariable

OPT: Public IP echo service API to use or an echoip URL in the form echoip#https://xyz (ipinfo,ifconfigco,ip2location,cloudflare or custom URL) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: PUBLICIP_API
Value: ipinfo,ifconfigco,ip2location,cloudflare

Others - Public IP TokenVariable

OPT: Optional API token for the public IP echo service to increase rate limiting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: PUBLICIP_API_TOKEN

Others - Public IP FileVariable

OPT: Filepath to store the public IP address assigned. This will be removed in the v4 program, instead you might want to use the [control server](https://github.com/qdm12/gluetun-wiki/blob/main/setup/advanced/control-server.md) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: PUBLICIP_FILE
Default: /gluetun/ip
Value: /gluetun/ip

Others - Version InformationVariable

OPT: Logs a message indicating if a newer version is available once the VPN is connected (on,off) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: VERSION_INFORMATION
Default: on|off
Value: on

Others - Boring Poll Gluetun[dot]comVariable

OPT: Fight AI slop and help the Gluetun community by [polling periodically every few minutes a 500KB file](https://github.com/qdm12/gluetun/blob/master/internal/boringpoll/boringpoll.go) from gluetun[dot]com to make it unsustainable to host due to egress costs. (off,on) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/others.md

Target: BORINGPOLL_GLUETUNCOM
Default: off|on
Value: off

Storage - EnabledVariable

OPT: Enable or disable reading and writing servers to disk (yes or no) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/storage.md

Target: STORAGE_SERVERS_ENABLED
Default: yes|no
Value: yes

Storage - Directory PathVariable

OPT: Path to the directory where server files are stored (Valid directory path) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . https://github.com/qdm12/gluetun-wiki/blob/main/setup/options/storage.md

Target: STORAGE_SERVERS_DIRECTORY_PATH
Default: /gluetun/servers
Value: /gluetun/servers

Tailscale Fallback State DirectoryVariable

Fallback container directory for tailscale state information

Target: CA_TS_FALLBACK_DIR
Default: /gluetun
Value: /gluetun

Library

Curated

Categories