Skip to content

GeoffreyCoulaud/glueforward

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

48 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

glueforward

Updates qbittorrent's listening port to be gluetun's forwarded port on the VPN side.

The goal is to no longer query a file for the exposed port status, but instead use gluetun's API. This is in preparation for the deprecation of the file approach in a future version of gluetun.

Usage

The recommended way to use glueforward is with docker compose.

services:
  glueforward:
    image: ghcr.io/geoffreycoulaud/glueforward:latest
    container_name: glueforward
    environment:
      GLUETUN_URL: "..."
      GLUETUN_API_KEY: "..."
      QBITTORRENT_URL: "..."
      QBITTORRENT_USERNAME: "..."
      QBITTORRENT_PASSWORD: "..."
    depends_on:
      - gluetun
      - qbittorrent
  gluetun:
    # Insert gluetun service definition here
  qbittorrent:
    # Insert qbittorrent service definition here

Environment variables

Name Description Optional Default value
GLUETUN_URL Url to the gluetun control server No
GLUETUN_API_KEY Your gluetun control server API key No¹
QBITTORRENT_URL Url to the qbittorrent web UI No
QBITTORRENT_USERNAME Username to authenticate to qbittorrent No
QBITTORRENT_PASSWORD Password to authenticate to qbittorrent No
SUCCESS_INTERVAL Interval in seconds between updates Yes 300
RETRY_INTERVAL Interval in seconds between updates in case of a failure (eg. one of the servers is unreachable) Yes 10
LOG_LEVEL Minimum level of severity for a message to be logged.
Available values are CRITICAL, ERROR, WARNING, INFO, DEBUG
Yes INFO
  1. Optional before gluetun v3.40.0, where all control server routes become private by default

Other info

  • Ensure that gluetun and qbittorrent are reachable from glueforward.
    For example: If you separate services in different networks, make sure glueforward has access to the appropriate ones.
  • Gluetun wiki - VPN server port forwarding