From 7ad6fc8e73ad52f3084806ed760cd596779d809f Mon Sep 17 00:00:00 2001 From: Quentin McGaw Date: Sat, 16 Apr 2022 21:08:49 +0000 Subject: [PATCH] docs(maintenance): update document --- maintenance.md | 47 ++++++++++++++--------------------------------- 1 file changed, 14 insertions(+), 33 deletions(-) diff --git a/maintenance.md b/maintenance.md index afa4233f..84cb2465 100644 --- a/maintenance.md +++ b/maintenance.md @@ -1,45 +1,25 @@ # Maintenance -## With caution - -- Remove duplicate `/gluetun` directory creation -- Remove firewall shadowsocks input port? -- Remove `script-security` option - -## Uniformization - -- Filter servers by protocol for all -- Multiple IPs addresses support for all proviedrs -- UPDATER_PERIOD only update provider in use - -## Code - +- Rename `UNBLOCK` to `DOT_UNBOUND_UNBLOCK` +- Move constants.*RegionChoices to a validation package +- Common filtering functions +- Refactor providers code to have one directory per VPN provider +- Use DNS v2 beta +- Go 1.18 + - gofumpt + - Use netip +- Split servers.json and compress it, use Git LFS +- DNS block lists as LFS and built in image +- Finish HTTP server v1 or v2 - Use `github.com/qdm12/ddns-updater/pkg/publicip` - Windows and Darwin development support -- Use `internal/netlink` in firewall and routing packages ## Features -- Pprof server -- Pre-install DNSSEC files so DoT can be activated even before the tunnel is up -- Gluetun entire logs available at control server, maybe in structured format - Authentication with the control server - Get announcement from Github file - Support multiple connections in custom ovpn - -## Gluetun pre-v4 - -- Finish HTTP server v1 or v2 -- Renamings - - `UNBLOCK` to `DOT_UNBOUND_UNBLOCK` - - `PIA_ENCRYPTION` to `PRIVATE_INTERNET_ACCESS_OPENVPN_ENCRYPTION_PRESET` - - `PORT_FORWARDING` to `PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING` - - Rename PIA's `REGION` to `COUNTRY` - - `WIREGUARD_ADDRESS` to `WIREGUARD_ADDRESSES` - - `VPNSP` to `VPN_SERVICE_PROVIDER` - - Rename `REGION` (etc.) to `SERVER_REGIONS` - - `OPENVPN_CIPHER` to `OPENVPN_CIPHERS` -- Split servers.json and compress it +- Automate IPv6 detection for OpenVPN ## Gluetun V4 @@ -59,10 +39,11 @@ - Remove `OPENVPN_CONFIG` != "" implies `VPNSP` = "custom" AND set `OPENVPN_CUSTOM_CONFIG` default to `/gluetun/custom.ovpn` - Remove functionalities - `SERVER_NUMBER` + - `SERVER_NAME` - `PUBLICIP_FILE` - `PORT_FORWARDING_STATUS_FILE` - Updater servers version reset to 1 -- Remove HTTP server v0 +- Reset HTTP server version to v1 and remove older ones - Change to compulsory - `VPN_SERVICE_PROVIDER` - Use relative paths everywhere instead of absolute