vanja/gluetun
1
0
Fork 0
mirror of https://github.com/qdm12/gluetun.git synced 2026-05-06 20:10:11 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs(maintenance): update document

Browse Source
This commit is contained in:
Quentin McGaw
2022-04-16 21:08:49 +00:00
parent 31c7e6362b
commit 7ad6fc8e73
1 changed files with 14 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
maintenance.md
+14 -33
View File
@@ -1,45 +1,25 @@
# Maintenance # Maintenance
## With caution - Rename `UNBLOCK` to `DOT_UNBOUND_UNBLOCK`
- Move constants.*RegionChoices to a validation package
- Remove duplicate `/gluetun` directory creation - Common filtering functions
- Remove firewall shadowsocks input port? - Refactor providers code to have one directory per VPN provider
- Remove `script-security` option - Use DNS v2 beta
- Go 1.18
## Uniformization - gofumpt
- Use netip
- Filter servers by protocol for all - Split servers.json and compress it, use Git LFS
- Multiple IPs addresses support for all proviedrs - DNS block lists as LFS and built in image
- UPDATER_PERIOD only update provider in use - Finish HTTP server v1 or v2
## Code
- Use `github.com/qdm12/ddns-updater/pkg/publicip` - Use `github.com/qdm12/ddns-updater/pkg/publicip`
- Windows and Darwin development support - Windows and Darwin development support
- Use `internal/netlink` in firewall and routing packages
## Features ## 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 - Authentication with the control server
- Get announcement from Github file - Get announcement from Github file
- Support multiple connections in custom ovpn - Support multiple connections in custom ovpn
- Automate IPv6 detection for OpenVPN
## 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
## Gluetun V4 ## Gluetun V4
@@ -59,10 +39,11 @@
- Remove `OPENVPN_CONFIG` != "" implies `VPNSP` = "custom" AND set `OPENVPN_CUSTOM_CONFIG` default to `/gluetun/custom.ovpn` - Remove `OPENVPN_CONFIG` != "" implies `VPNSP` = "custom" AND set `OPENVPN_CUSTOM_CONFIG` default to `/gluetun/custom.ovpn`
- Remove functionalities - Remove functionalities
- `SERVER_NUMBER` - `SERVER_NUMBER`
- `SERVER_NAME`
- `PUBLICIP_FILE` - `PUBLICIP_FILE`
- `PORT_FORWARDING_STATUS_FILE` - `PORT_FORWARDING_STATUS_FILE`
- Updater servers version reset to 1 - Updater servers version reset to 1
- Remove HTTP server v0 - Reset HTTP server version to v1 and remove older ones
- Change to compulsory - Change to compulsory
- `VPN_SERVICE_PROVIDER` - `VPN_SERVICE_PROVIDER`
- Use relative paths everywhere instead of absolute - Use relative paths everywhere instead of absolute