gluetun

n8n community node to control a gluetun VPN client via its HTTP control server

Package Information

Released: 3 mo ago
Downloads: 0 weekly / 0 monthly
Latest Version: 0.1.6

Available Nodes

Documentation generating…

Gluetun icon
Gluetun
Control a gluetun VPN client through its HTTP control server

Documentation

Gluetun

n8n-nodes-gluetun

npm version
npm downloads
License: MIT
n8n verified

Community node for n8n to control a gluetun VPN
client through its HTTP control server.

✅ Verified community node — available directly from the node panel in n8n
(self-hosted and n8n Cloud).

Installation

This is a verified community node: in n8n, click + (Add node) and search for
gluetun — no manual install needed.

Manual install (older n8n, or as an unverified package)

Settings → Community Nodes → Install → n8n-nodes-gluetun.

Operations

Operation Endpoint Description
Get Public IP GET /v1/publicip/ip Public IP, country, region of the VPN exit
Get VPN Status GET /v1/vpn/status Current VPN status (running / stopped)
Set VPN Status PUT /v1/vpn/status Start or stop the VPN
Get Forwarded Port GET /v1/openvpn/portforwarded The VPN forwarded port
Get DNS Status GET /v1/dns/status Current DNS-over-TLS status

Credentials

Create a Gluetun API credential:

  • Base URL — e.g. http://gluetun:8000 (control server address; HTTP_CONTROL_SERVER_ADDRESS).
  • API Key — only if the control server has API key auth enabled (sent as X-API-Key).

Example

Keep your torrent client in sync with the VPN: Get Forwarded Port → push the value
into your download client's listening port. Or Get Public IP on a schedule and alert
if the VPN exit changes or drops.

Build

npm install --ignore-scripts
npm run build

Usage example

Read the VPN public IP:

  1. Add the node after a trigger (e.g. When clicking 'Test workflow').
  2. Select your credential.
  3. Get Public IP.
  4. Execute the node — example output:
{ "public_ip": "203.0.113.42", "country": "Netherlands", "city": "Amsterdam" }

Disclaimer

This project isn't affiliated with or endorsed by the gluetun project. gluetun is the
property of its respective authors.

Discussion