From 43514cc9cb1fc7aeac383d0c2b153fd3a0444a0b Mon Sep 17 00:00:00 2001
From: Tomasz Borychowski <github@borychowski.org>
Date: Mon, 23 May 2022 22:45:22 +0100
Subject: [PATCH] vpn

---
 README.md         |  3 ++-
 apps/other/vpn.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 49 insertions(+), 1 deletion(-)
 create mode 100644 apps/other/vpn.md

diff --git a/README.md b/README.md
index 335a2c9..4cf819b 100644
--- a/README.md
+++ b/README.md
@@ -77,6 +77,7 @@ The aims is to provide a ready-to-run recipes that you can just copy, paste and
 - [Shaark](apps/bookmarks/shaark.md)
 - [Wallabag](apps/bookmarks/wallabag.md)
 
+
 ### Other
 - [Nunux Keeper](https://keeper.nunux.org/) 🔗 - similar to wallabag, but not as good (more complicated, less usable and doesn't have mobile apps).
 - [Reminescence](https://github.com/kanishka-linux/reminiscence#using-docker) 🔗 - Clean and simple. Has a DIY-Docker-Image. Buggy (archiving doesn't work half of the time).
@@ -269,7 +270,7 @@ The aims is to provide a ready-to-run recipes that you can just copy, paste and
 - [Cockpit](apps/other/cockpit.md)
 - [Code server](apps/other/code.md)
 - [Firefox sync server](apps/other/firefox-sync.md)
-
+- [VPN client](apps/other/vpn.md)
 
 
 # Photos
diff --git a/apps/other/vpn.md b/apps/other/vpn.md
new file mode 100644
index 0000000..f47dd10
--- /dev/null
+++ b/apps/other/vpn.md
@@ -0,0 +1,47 @@
+# Gluetun VPN client
+A VPN client to tunnel to Cyberghost, ExpressVPN, FastestVPN, HideMyAss, IPVanish, IVPN, Mullvad, NordVPN, Perfect Privacy, Privado, Private Internet Access, PrivateVPN, ProtonVPN, PureVPN, Surfshark, TorGuard, VPNUnlimited, VyprVPN, WeVPN and Windscribe VPN servers using Go, OpenVPN or Wireguard, iptables, DNS over TLS, ShadowSocks and an HTTP proxy.<br>
+
+- [Github repo](https://github.com/qdm12/gluetun)
+- [Docker Hub](https://hub.docker.com/r/qmcgaw/gluetun)
+
+## Requirements
+An account with a compatible VPN provider is required.
+
+## docker-compose.yml
+```yml
+---
+version: "3"
+services:
+  gluetun:
+    image: qmcgaw/gluetun
+    container_name: gluetun
+    restart: unless-stopped
+    cap_add:
+      - NET_ADMIN
+    environment:
+      - TZ=Europe/Dublin
+      - VPN_TYPE=openvpn
+      - VPNSP=fastestvpn
+      - OPENVPN_USER=<VPN LOGIN>
+      - OPENVPN_PASSWORD=<VPN PASSWORD>
+      - COUNTRY=<VPN COUNTRY>
+    volumes:
+      - ./data:/gluetun
+      - ./data/port_forward:/tmp/gluetun/forwarded_port
+    ports:
+      #- 8888:8888/tcp # HTTP proxy
+      - 3020:8000/tcp # Built-in HTTP control server
+      - 9117:9117     # jackett
+      - 6881:6881     # qbit
+      - 3030:3030     # qbit webUI
+```
+
+and then - in the corresponding service `docker-compose.yml`, e.g.:
+```yml
+---
+version: "3"
+services:
+  jackett:
+    image: ghcr.io/linuxserver/jackett
+    network_mode: "container:gluetun"
+```