diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 022d356e..b116aaf8 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -13,6 +13,6 @@ Contributions are [released](https://help.github.com/articles/github-terms-of-se ## Resources -- [Gluetun guide on development](https://github.com/qdm12/gluetun/wiki/Development) +- [Gluetun guide on development](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/development.md) - [Using Pull Requests](https://help.github.com/articles/about-pull-requests/) - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml index 84bd06ed..04c48f48 100644 --- a/.github/ISSUE_TEMPLATE/bug.yml +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -13,7 +13,7 @@ body: label: Is this urgent? description: | Is this a critical bug, or do you need this fixed urgently? - If this is urgent, note you can use one of the [image tags available](https://github.com/qdm12/gluetun/wiki/Docker-image-tags) if that can help. + If this is urgent, note you can use one of the [image tags available](https://github.com/qdm12/gluetun-wiki/blob/main/setup/docker-image-tags.md) if that can help. options: - "No" - "Yes" diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index a2dd0ccf..cd184448 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,4 +1,7 @@ contact_links: + - name: Report a Wiki issue + url: https://github.com/qdm12/gluetun-wiki/issues/new + about: Please create an issue on the gluetun-wiki repository. - name: Configuration help? url: https://github.com/qdm12/gluetun/discussions/new about: Please create a Github discussion. diff --git a/.github/ISSUE_TEMPLATE/provider.md b/.github/ISSUE_TEMPLATE/provider.md index ce2effd7..802a44dc 100644 --- a/.github/ISSUE_TEMPLATE/provider.md +++ b/.github/ISSUE_TEMPLATE/provider.md @@ -14,4 +14,4 @@ One of the following is required: If the list of servers requires to login **or** is hidden behind an interactive configurator, you can only use a custom Openvpn configuration file. -[The Wiki](https://github.com/qdm12/gluetun/wiki/Openvpn-file) describes how to do so. +[The Wiki's OpenVPN configuration file page](https://github.com/qdm12/gluetun-wiki/blob/main/setup/openvpn-configuration-file.md) describes how to do so. diff --git a/.github/ISSUE_TEMPLATE/wiki issue.yml b/.github/ISSUE_TEMPLATE/wiki issue.yml deleted file mode 100644 index d6f8cb57..00000000 --- a/.github/ISSUE_TEMPLATE/wiki issue.yml +++ /dev/null @@ -1,18 +0,0 @@ -name: Wiki issue -description: Report a Wiki issue -title: "Wiki issue: " -labels: ["๐Ÿ“„ Wiki issue"] -body: - - type: input - id: url - attributes: - label: "URL to the Wiki page" - placeholder: "https://github.com/qdm12/gluetun/wiki/OpenVPN-options" - validations: - required: true - - type: textarea - id: description - attributes: - label: "What's the issue?" - validations: - required: true diff --git a/README.md b/README.md index d7e693a1..3ffc33ff 100644 --- a/README.md +++ b/README.md @@ -38,7 +38,7 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers - [Setup](#setup) - [Features](#features) - Problem? - - [Check the Wiki](https://github.com/qdm12/gluetun/wiki) + - Check the Wiki [common errors](https://github.com/qdm12/gluetun-wiki/tree/main/errors) and [faq](https://github.com/qdm12/gluetun-wiki/tree/main/faq) - [Start a discussion](https://github.com/qdm12/gluetun/discussions) - [Fix the Unraid template](https://github.com/qdm12/gluetun/discussions/550) - Suggestion? @@ -47,7 +47,7 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers - 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) -- **Want to add a VPN provider?** check [Development](https://github.com/qdm12/gluetun/wiki/Development) and [Add a provider](https://github.com/qdm12/gluetun/wiki/Add-a-provider) +- **Want to add a VPN provider?** check [the development page](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/development.md) and [add a provider page](https://github.com/qdm12/gluetun-wiki/blob/main/contributing/add-a-provider.md) - Video: [![Video Gif](https://i.imgur.com/CetWunc.gif)](https://youtu.be/0F6I03LQcI4) @@ -61,8 +61,8 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers - Supports OpenVPN for all providers listed - Supports Wireguard both kernelspace and userspace - For **AirVPN**, **Ivpn**, **Mullvad**, **NordVPN**, **Surfshark** and **Windscribe** - - For **ProtonVPN**, **PureVPN**, **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) + - For **ProtonVPN**, **PureVPN**, **Torguard**, **VPN Unlimited** and **WeVPN** using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md) + - For custom Wireguard configurations using [the custom provider](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/custom.md) - More in progress, see [#134](https://github.com/qdm12/gluetun/issues/134) - DNS over TLS baked in with service provider(s) of your choice - DNS fine blocking of malicious/ads/surveillance hostnames and IP addresses, with live update every 24 hours @@ -70,10 +70,10 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers - Built in firewall kill switch to allow traffic only with needed the VPN servers and LAN devices - Built in Shadowsocks proxy (protocol based on SOCKS5 with an encryption layer, tunnels TCP+UDP) - Built in HTTP proxy (tunnels HTTP and HTTPS through TCP) -- [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) +- [Connect other containers to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md) +- [Connect LAN devices to it](https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-lan-device-to-gluetun.md) - Compatible with amd64, i686 (32 bit), **ARM** 64 bit, ARM 32 bit v6 and v7, and even ppc64le ๐ŸŽ† -- [Custom VPN server side port forwarding for Private Internet Access](https://github.com/qdm12/gluetun/wiki/Private-internet-access#vpn-server-port-forwarding) +- [Custom VPN server side port forwarding for Private Internet Access](https://github.com/qdm12/gluetun-wiki/blob/main/setup/providers/private-internet-access.md#vpn-server-port-forwarding) - Possibility of split horizon DNS by selecting multiple DNS over TLS providers - Unbound subprogram drops root privileges once launched - Can work as a Kubernetes sidecar container, thanks @rorph @@ -82,9 +82,9 @@ Lightweight swiss-knife-like VPN client to multiple VPN service providers ๐ŸŽ‰ 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)! +Go to the [Wiki](https://github.com/qdm12/gluetun-wiki)! -[๐Ÿ› 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+) +[๐Ÿ› Found a bug in the Wiki?!](https://github.com/qdm12/gluetun-wiki/issues/new) Here's a docker-compose.yml for the laziest: @@ -94,7 +94,8 @@ services: gluetun: image: qmcgaw/gluetun # 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 + # line above must be uncommented to allow external containers to connect. + # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/connect-a-container-to-gluetun.md#external-container-to-gluetun cap_add: - NET_ADMIN devices: @@ -106,7 +107,7 @@ services: volumes: - /yourpath:/gluetun environment: - # See https://github.com/qdm12/gluetun/wiki + # See https://github.com/qdm12/gluetun-wiki/tree/main/setup#setup - VPN_SERVICE_PROVIDER=ivpn - VPN_TYPE=openvpn # OpenVPN: @@ -117,7 +118,8 @@ services: # - WIREGUARD_ADDRESSES=10.64.222.21/32 # Timezone for accurate log times - TZ= - # Server list updater. See https://github.com/qdm12/gluetun/wiki/Updating-Servers#periodic-update + # Server list updater + # See https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list - UPDATER_PERIOD= ``` diff --git a/cmd/gluetun/main.go b/cmd/gluetun/main.go index bfc12a8a..16bcfdf4 100644 --- a/cmd/gluetun/main.go +++ b/cmd/gluetun/main.go @@ -159,7 +159,7 @@ func _main(ctx context.Context, buildInfo models.BuildInformation, } } - announcementExp, err := time.Parse(time.RFC3339, "2021-02-15T00:00:00Z") + announcementExp, err := time.Parse(time.RFC3339, "2023-07-01T00:00:00Z") if err != nil { return err } @@ -170,7 +170,7 @@ func _main(ctx context.Context, buildInfo models.BuildInformation, Version: buildInfo.Version, Commit: buildInfo.Commit, BuildDate: buildInfo.Created, - Announcement: "Large settings parsing refactoring merged on 2022-01-06, please report any issue!", + Announcement: "Wiki moved to https://github.com/qdm12/gluetun-wiki", AnnounceExp: announcementExp, // Sponsor information PaypalUser: "qmcgaw", diff --git a/internal/healthcheck/openvpn.go b/internal/healthcheck/openvpn.go index b1781dcc..8c1321cc 100644 --- a/internal/healthcheck/openvpn.go +++ b/internal/healthcheck/openvpn.go @@ -16,7 +16,7 @@ type vpnHealth struct { func (s *Server) onUnhealthyVPN(ctx context.Context) { s.logger.Info("program has been unhealthy for " + s.vpn.healthyWait.String() + ": restarting VPN " + - "(see https://github.com/qdm12/gluetun/wiki/Healthcheck)") + "(see https://github.com/qdm12/gluetun-wiki/blob/main/faq/healthcheck.md)") _, _ = s.vpn.loop.ApplyStatus(ctx, constants.Stopped) _, _ = s.vpn.loop.ApplyStatus(ctx, constants.Running) s.vpn.healthyWait += *s.config.VPN.Addition diff --git a/internal/openvpn/logs.go b/internal/openvpn/logs.go index f1946ebf..c20cc9a1 100644 --- a/internal/openvpn/logs.go +++ b/internal/openvpn/logs.go @@ -52,7 +52,7 @@ Your credentials might be wrong ๐Ÿคจ That error usually happens because either: 1. The VPN server IP address you are trying to connect to is no longer valid ๐Ÿ”Œ - Update your server information using https://github.com/qdm12/gluetun/wiki/Updating-Servers + Check out https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list 2. The VPN server crashed ๐Ÿ’ฅ, try changing your VPN servers filtering options such as SERVER_REGIONS diff --git a/internal/openvpn/logs_test.go b/internal/openvpn/logs_test.go index a9f099ff..00929a13 100644 --- a/internal/openvpn/logs_test.go +++ b/internal/openvpn/logs_test.go @@ -52,7 +52,7 @@ func Test_processLogLine(t *testing.T) { That error usually happens because either: 1. The VPN server IP address you are trying to connect to is no longer valid ๐Ÿ”Œ - Update your server information using https://github.com/qdm12/gluetun/wiki/Updating-Servers + Check out https://github.com/qdm12/gluetun-wiki/blob/main/setup/servers.md#update-the-vpn-servers-list 2. The VPN server crashed ๐Ÿ’ฅ, try changing your VPN servers filtering options such as SERVER_REGIONS