admin/gluetun
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
ff3f84f9fd1c6ee7de3deed5883e7fd6ca645c09
gluetun/README.md

128 lines
7.5 KiB
Markdown
Raw Normal View History

Windscribe support (#114)
2020-03-29 16:42:06 -04:00
# Gluetun VPN client
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
Feat: ExpressVPN support (#623)
2021-09-23 10:19:30 -07:00
*Lightweight swiss-knife-like VPN client to tunnel to Cyberghost, ExpressVPN, FastestVPN,
Feat: Perfect privacy support (#606)
2021-10-05 10:44:15 -07:00
HideMyAss, IPVanish, IVPN, Mullvad, NordVPN, Perfect Privacy, Privado, Private Internet Access, PrivateVPN,
Feat: WeVPN support (#591)
2021-09-23 07:58:13 -07:00
ProtonVPN, PureVPN, Surfshark, TorGuard, VPNUnlimited, VyprVPN, WeVPN and Windscribe VPN servers
Docs: add wireguard in top description
2021-09-10 22:18:29 +00:00
using Go, OpenVPN or Wireguard, iptables, DNS over TLS, ShadowSocks and an HTTP proxy*
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
chore(settings): refactor settings processing (#756) - Better settings tree structure logged using `qdm12/gotree` - Read settings from environment variables, then files, then secret files - Settings methods to default them, merge them and override them - `DNS_PLAINTEXT_ADDRESS` default changed to `127.0.0.1` to use DoT. Warning added if set to something else. - `HTTPPROXY_LISTENING_ADDRESS` instead of `HTTPPROXY_PORT` (with retro-compatibility)
2022-01-06 06:40:23 -05:00
**ANNOUNCEMENT**: Large settings refactor merged on 2022-06-01, please file issues if you find any problem!
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
Doc: use native markdown for svg title image
2021-07-14 22:08:40 +00:00
![Title image](https://raw.githubusercontent.com/qdm12/gluetun/master/title.svg)
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
Maint: rename build.yml to ci.yml for linting
2021-07-19 02:20:23 +00:00
[![Build status](https://github.com/qdm12/gluetun/actions/workflows/ci.yml/badge.svg)](https://github.com/qdm12/gluetun/actions/workflows/ci.yml)
Change: gluetun docker image name
2020-12-29 22:10:44 +00:00
Doc: simplify metdata and move it at top of readme
2021-07-14 22:17:51 +00:00
[![Docker pulls qmcgaw/gluetun](https://img.shields.io/docker/pulls/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
[![Docker pulls qmcgaw/private-internet-access](https://img.shields.io/docker/pulls/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
[![Docker stars qmcgaw/gluetun](https://img.shields.io/docker/stars/qmcgaw/gluetun.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
[![Docker stars qmcgaw/private-internet-access](https://img.shields.io/docker/stars/qmcgaw/private-internet-access.svg)](https://hub.docker.com/r/qmcgaw/gluetun)
Change: gluetun docker image name
2020-12-29 22:10:44 +00:00
Documentation: Moare badges and metadata
2020-12-30 22:29:18 +00:00
![Last release](https://img.shields.io/github/release/qdm12/gluetun?label=Last%20release)
![Last Docker tag](https://img.shields.io/docker/v/qmcgaw/gluetun?sort=semver&label=Last%20Docker%20tag)
Doc: simplify metdata and move it at top of readme
2021-07-14 22:17:51 +00:00
[![Last release size](https://img.shields.io/docker/image-size/qmcgaw/gluetun?sort=semver&label=Last%20released%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags?page=1&ordering=last_updated)
![GitHub last release date](https://img.shields.io/github/release-date/qdm12/gluetun?label=Last%20release%20date)
Documentation: Moare badges and metadata
2020-12-30 22:29:18 +00:00
![Commits since release](https://img.shields.io/github/commits-since/qdm12/gluetun/latest?sort=semver)
Doc: simplify metdata and move it at top of readme
2021-07-14 22:17:51 +00:00
[![Latest size](https://img.shields.io/docker/image-size/qmcgaw/gluetun/latest?label=Latest%20image)](https://hub.docker.com/r/qmcgaw/gluetun/tags)
[![GitHub last commit](https://img.shields.io/github/last-commit/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/commits/master)
[![GitHub commit activity](https://img.shields.io/github/commit-activity/y/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/graphs/contributors)
[![GitHub closed PRs](https://img.shields.io/github/issues-pr-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/pulls?q=is%3Apr+is%3Aclosed)
[![GitHub issues](https://img.shields.io/github/issues/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues)
[![GitHub closed issues](https://img.shields.io/github/issues-closed/qdm12/gluetun.svg)](https://github.com/qdm12/gluetun/issues?q=is%3Aissue+is%3Aclosed)
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
Documentation: Moare badges and metadata
2020-12-30 22:29:18 +00:00
[![Lines of code](https://img.shields.io/tokei/lines/github/qdm12/gluetun)](https://github.com/qdm12/gluetun)
Doc: simplify metdata and move it at top of readme
2021-07-14 22:17:51 +00:00
![Code size](https://img.shields.io/github/languages/code-size/qdm12/gluetun)
![GitHub repo size](https://img.shields.io/github/repo-size/qdm12/gluetun)
![Go version](https://img.shields.io/github/go-mod/go-version/qdm12/gluetun)
![Visitors count](https://visitor-badge.laobi.icu/badge?page_id=gluetun.readme)
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
Documentation: readme changes - Remove videos section (outdated) - Add quick links section for help and support - Simplify support section
2020-12-29 23:00:55 +00:00
## Quick links
Youtube videos added
2020-09-09 20:52:22 +00:00
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
- [Setup](#Setup)
- [Features](#Features)
- Problem?
- [Check the Wiki](https://github.com/qdm12/gluetun/wiki)
Documentation: readme changes - Remove videos section (outdated) - Add quick links section for help and support - Simplify support section
2020-12-29 23:00:55 +00:00
- [Start a discussion](https://github.com/qdm12/gluetun/discussions)
Docs: add fix the unraid template link
2021-09-10 21:11:08 +00:00
- [Fix the Unraid template](https://github.com/qdm12/gluetun/discussions/550)
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
- Suggestion?
- [Create an issue](https://github.com/qdm12/gluetun/issues)
Documentation: readme changes - Remove videos section (outdated) - Add quick links section for help and support - Simplify support section
2020-12-29 23:00:55 +00:00
- [Join the Slack channel](https://join.slack.com/t/qdm12/shared_invite/enQtOTE0NjcxNTM1ODc5LTYyZmVlOTM3MGI4ZWU0YmJkMjUxNmQ4ODQ2OTAwYzMxMTlhY2Q1MWQyOWUyNjc2ODliNjFjMDUxNWNmNzk5MDk)
- Happy?
- Sponsor me on [github.com/sponsors/qdm12](https://github.com/sponsors/qdm12)
- Donate to [paypal.me/qmcgaw](https://www.paypal.me/qmcgaw)
- Drop me [an email](mailto:quentin.mcgaw@gmail.com)
Doc: add video
2021-07-14 00:31:27 +00:00
- Video:
[![Video Gif](https://i.imgur.com/CetWunc.gif)](https://youtu.be/0F6I03LQcI4)
Youtube videos added
2020-09-09 20:52:22 +00:00
Doc: add Console Substack interview link
2021-09-27 13:24:31 +00:00
- [Substack Console interview](https://console.substack.com/p/console-72)
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
## Features
feat(docker): upgrade Alpine to 3.15
2021-12-14 18:16:51 +00:00
- Based on Alpine 3.15 for a small Docker image of 29MB
Feat: Perfect privacy support (#606)
2021-10-05 10:44:15 -07:00
- Supports: **Cyberghost**, **ExpressVPN**, **FastestVPN**, **HideMyAss**, **IPVanish**, **IVPN**, **Mullvad**, **NordVPN**, **Perfect Privacy**, **Privado**, **Private Internet Access**, **PrivateVPN**, **ProtonVPN**, **PureVPN**, **Surfshark**, **TorGuard**, **VPNUnlimited**, **Vyprvpn**, **WeVPN**, **Windscribe** servers
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
- Supports OpenVPN for all providers listed
feat(internal/wireguard): opportunistic kernelspace - Auto detect if kernelspace implementation is available - Fallback to Go userspace implementation if kernel is not available
2021-12-14 11:03:36 +00:00
- Supports Wireguard both kernelspace and userspace
Docs: update Wireguard support list in readme
2021-09-13 20:23:16 +00:00
- For **Mullvad**, **Ivpn** and **Windscribe**
Doc: fix readme Wiki links
2021-10-06 17:47:08 +00:00
- For **Torguard**, **VPN Unlimited** and **WeVPN** using [the custom provider](https://github.com/qdm12/gluetun/wiki/Custom-provider)
- For custom Wireguard configurations using [the custom provider](https://github.com/qdm12/gluetun/wiki/Custom-provider)
Docs: update Wireguard support list in readme
2021-09-13 20:23:16 +00:00
- More in progress, see [#134](https://github.com/qdm12/gluetun/issues/134)
README: Updated and refactored features section
2020-02-22 17:06:35 +00:00
- DNS over TLS baked in with service provider(s) of your choice
Unbound restart logic - Update files and restart unbound every 24hours - HTTP route to force update & restart of Unbound - Fix #151
2020-05-02 17:08:15 +00:00
- DNS fine blocking of malicious/ads/surveillance hostnames and IP addresses, with live update every 24 hours
README: Updated and refactored features section
2020-02-22 17:06:35 +00:00
- Choose the vpn network protocol, `udp` or `tcp`
Replace pia with gluetun wherever possible - in Readme documentation - Changed splash title string - Changed Dockerfile labels - Changed commands and docker-compose service & container name
2020-06-03 02:11:35 +00:00
- Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices
Fix Shadowsocks documentation, fixing #245
2020-09-18 19:56:53 +00:00
- Built in Shadowsocks proxy (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP)
HTTP proxy written in Go to replace Tinyproxy (#269)
2020-10-31 21:50:31 -04:00
- Built in HTTP proxy (tunnels HTTP and HTTPS through TCP)
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
- [Connect other containers to it](https://github.com/qdm12/gluetun/wiki/Connect-a-container-to-gluetun)
- [Connect LAN devices to it](https://github.com/qdm12/gluetun/wiki/Connect-a-LAN-device-to-gluetun)
CI: Alpine s390x build removed (periodic crashes)
2021-02-14 18:59:27 +00:00
- Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7, and even ppc64le 🎆
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
- [Custom VPN server side port forwarding for Private Internet Access](https://github.com/qdm12/gluetun/wiki/Private-internet-access#vpn-server-port-forwarding)
Minor changes
2020-02-22 17:07:06 +00:00
- Possibility of split horizon DNS by selecting multiple DNS over TLS providers
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
- Unbound subprogram drops root privileges once launched
Minor changes
2020-02-22 17:07:06 +00:00
- Can work as a Kubernetes sidecar container, thanks @rorph
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
## Setup
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
🎉 There are now instructions specific to each VPN provider with examples to help you get started as quickly as possible!
Go to the [Wiki](https://github.com/qdm12/gluetun/wiki)!
Doc: fix readme Wiki links
2021-10-06 17:47:08 +00:00
[🐛 Found a bug in the Wiki?!](https://github.com/qdm12/gluetun/issues/new?assignees=&labels=%F0%9F%93%84+Wiki+issue&template=wiki+issue.yml&title=Wiki+issue%3A+)
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
Here's a docker-compose.yml for the laziest:
```yml
version: "3"
services:
gluetun:
image: qmcgaw/gluetun
docs(docker-compose): add `container_name` commented line (#806)
2022-01-23 01:44:16 +01:00
# container_name: gluetun
# line above must be uncommented to allow external containers to connect. See https://github.com/qdm12/gluetun/wiki/Connect-a-container-to-gluetun#external-container-to-gluetun
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
cap_add:
- NET_ADMIN
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
chore(env): `VPN_SERVICE_PROVIDER` variable - With retro-compatibility with `VPNSP`
2022-02-05 22:34:35 +00:00
- VPN_SERVICE_PROVIDER=ivpn
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
- VPN_TYPE=openvpn
# OpenVPN:
- OPENVPN_USER=
- OPENVPN_PASSWORD=
# Wireguard:
# - WIREGUARD_PRIVATE_KEY=wOEI9rqqbDwnN8/Bpp22sVz48T71vJ4fYmFWujulwUU=
chore(env): `WIREGUARD_ADDRESSES` variable - With retro-compatibility with `WIREGUARD_ADDRESS`
2022-02-05 22:31:46 +00:00
# - WIREGUARD_ADDRESSES=10.64.222.21/32
Doc: update readme with updated Wiki
2021-09-16 20:24:30 +00:00
# Timezone for accurate log times
- TZ=
```
Refers to #142
2020-05-02 14:59:22 +00:00
Rewrite of the entrypoint in Golang (#71) - General improvements - Parallel download of only needed files at start - Prettier console output with all streams merged (openvpn, unbound, shadowsocks etc.) - Simplified Docker final image - Faster bootup - DNS over TLS - Finer grain blocking at DNS level: malicious, ads and surveillance - Choose your DNS over TLS providers - Ability to use multiple DNS over TLS providers for DNS split horizon - Environment variables for DNS logging - DNS block lists needed are downloaded and built automatically at start, in parallel - PIA - A random region is selected if the REGION parameter is left empty (thanks @rorph for your PR) - Routing and iptables adjusted so it can work as a Kubernetes pod sidecar (thanks @rorph for your PR)
2020-02-06 20:42:46 -05:00
## License
Documentation: minor readme improvements
2020-12-31 04:49:18 +00:00
[![MIT](https://img.shields.io/github/license/qdm12/gluetun)](https://github.com/qdm12/gluetun/master/LICENSE)
Reference in New Issue Copy Permalink