Ansible Role: Gluetun-docker

Install Gluetun Docker Compose project.

• https://github.com/qdm12/gluetun
• https://hub.docker.com/r/qmcgaw/gluetun

Requirements

Requires the following to be installed:

• docker
• docker compose

Role Variables

Common system variables:

timezone: UTC

Common Docker projects variables:

# Base directory for Docker projects
docker_projects_path: # /var/apps

Available role variables are listed below, along with default values (see defaults/main.yml):

# Docker project variables

gluetun_project_name: gluetun

# Gluetun project variables

gluetun_version: latest

# Gluetun port mappings
gluetun_ports:
  # - "8888:8888/tcp # HTTP proxy"
  # - "8388:8388/tcp # Shadowsocks"
  # - "8388:8388/udp # Shadowsocks"
  # - "9091:9091/tcp # Transmission Web UI"
  # - "51413:51413/tcp # BitTorrent protocol"
  # - "51413:51413/udp # BitTorrent protocol"

# Gluetun environment variables
gluetun_environment:
  # See https://github.com/qdm12/gluetun-wiki/tree/main/setup#setup
  VPN_SERVICE_PROVIDER: example
  VPN_TYPE: # openvpn | wireguard

  # OpenVPN:
  # OPENVPN_USER:
  # OPENVPN_PASSWORD:
  # ...

  # Wireguard:
  # WIREGUARD_PRIVATE_KEY:
  # WIREGUARD_ADDRESSES:
  # ...

  # Server list updater
  # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list
  # UPDATER_PERIOD: 24h

Dependencies

This role depends on :

• djuuu.docker_project

Example Playbook

- hosts: example
  gather_facts: false

  roles:
    - djuuu.gluetun_docker

Integration in other projects

The template_service task will register a gluetun_service_yaml variable that can be used in other projects:

• example_playbook.yml

  - hosts: example
    gather_facts: false
  
    pre_tasks:
      - name: Template Gluetun service yaml
        ansible.builtin.include_role:
          name: djuuu.gluetun_docker
          tasks_from: template_service
  
    roles:
      - example_docker_role
  

• example_docker_role/templates/docker-compose.yml.j2

  services:
  
    example:
      # ...
      network_mode: "service:gluetun"
      depends_on:
        gluetun: { condition: service_healthy, restart: true }
      # ...
  
    {{ gluetun_service_yaml | default('') | indent(2) }}
  

License

Beerware License