maintenance.md

# Maintenance

- Rename `UNBLOCK` to `DNS_HOSTNAMES_UNBLOCKED`
- Change `Run` methods to `Start`+`Stop`, returning channels rather than injecting them
- Go 1.18
  - gofumpt
  - Use netip
- Split servers.json
- Common slice of Wireguard providers in config settings
- DNS block lists as LFS and built in image
- Add HTTP server v3 as json rpc
- Use `github.com/qdm12/ddns-updater/pkg/publicip`
- Windows and Darwin development support

## Features

- Authentication with the control server
- Get announcement from Github file
- Support multiple connections in custom ovpn
- Automate IPv6 detection for OpenVPN

## Gluetun V4

- Remove retro environment variables:
  - `PORT`
  - `UNBLOCK`
  - `PROTOCOL`
  - `PIA_ENCRYPTION`
  - `PORT_FORWARDING`, `PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING`
  - `WIREGUARD_PORT`
  - `REGION` for PIA, Cyberghost
  - `WIREGUARD_ADDRESS`
  - `VPNSP`
  - All old location filters such as `REGION`, `COUNTRY`, etc.
- Remove other retro logic
  - `VPNSP`'s `pia = private ...`
  - 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`, `PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING_STATUS_FILE`
- Updater servers version reset to 1
- Reset HTTP server version to v1 and remove older ones
- Change to compulsory
  - `VPN_SERVICE_PROVIDER`
- Use relative paths everywhere instead of absolute
Doc: maintenance document 2021-06-22 14:42:15 +00:00			`# Maintenance`

feat(dns): replace unbound with qdm12/dns@v2.0.0-beta-rc6 (#1742) - Faster start up - Clearer error messages - Allow for more Gluetun-specific customization - DNSSEC validation is dropped for now (it's sort of unneeded) - Fix #137 2024-08-21 14:35:41 +02:00			- Rename `UNBLOCK` to `DNS_HOSTNAMES_UNBLOCKED`
docs(maintenance): update document 2022-06-06 02:58:58 +00:00			- Change `Run` methods to `Start`+`Stop`, returning channels rather than injecting them
docs(maintenance): update document 2022-04-16 21:08:49 +00:00			`- Go 1.18`
			`- gofumpt`
			`- Use netip`
docs(maintenance): update document 2022-06-06 02:58:58 +00:00			`- Split servers.json`
feat(surfshark): Wireguard support (#587) 2022-08-26 10:55:46 -04:00			`- Common slice of Wireguard providers in config settings`
docs(maintenance): update document 2022-04-16 21:08:49 +00:00			`- DNS block lists as LFS and built in image`
docs(maintenance): update document 2022-06-06 02:58:58 +00:00			`- Add HTTP server v3 as json rpc`
Doc: maintenance document 2021-06-22 14:42:15 +00:00			- Use `github.com/qdm12/ddns-updater/pkg/publicip`
Docs: update maintenance document 2021-09-11 15:29:29 +00:00			`- Windows and Darwin development support`
Doc: maintenance document 2021-06-22 14:42:15 +00:00
			`## Features`

			`- Authentication with the control server`
Docs: update maintenance document 2021-09-11 15:29:29 +00:00			`- Get announcement from Github file`
`VPNSP` value `custom` for OpenVPN custom config files (#621) - Retro-compatibility: `OPENVPN_CUSTOM_CONFIG` set implies `VPNSP=custom` - Change: `up` and `down` options are not filtered out - Change: `OPENVPN_INTERFACE` overrides the network interface defined in the configuration file - Change: `PORT` overrides any port found in the configuration file - Feat: config file is read when building the OpenVPN configuration, so it's effectively reloaded on VPN restarts - Feat: extract values from custom file at start to log out valid settings - Maint: `internal/openvpn/extract` package instead of `internal/openvpn/custom` package - Maint: All providers' `BuildConf` method return an error - Maint: rename `CustomConfig` to `ConfFile` in Settings structures 2021-09-13 11:30:14 -04:00			`- Support multiple connections in custom ovpn`
docs(maintenance): update document 2022-04-16 21:08:49 +00:00			`- Automate IPv6 detection for OpenVPN`
Doc: update maintenance document 2021-09-16 20:42:39 +00:00
Doc: maintenance document 2021-06-22 14:42:15 +00:00			`## Gluetun V4`

Doc: update maintenance document 2021-09-16 20:42:39 +00:00			`- Remove retro environment variables:`
			- `PORT`
			- `UNBLOCK`
			- `PROTOCOL`
			- `PIA_ENCRYPTION`
feat(env): rename vpn port forwarding variables - `VPN_PORT_FORWARDING_STATUS_FILE` - `VPN_PORT_FORWARDING` - Deprecate PIA specific variables for VPN port forwarding 2023-04-27 10:22:23 +00:00			- `PORT_FORWARDING`, `PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING`
Doc: update maintenance document 2021-09-16 20:42:39 +00:00			- `WIREGUARD_PORT`
Maint: migrate Cyberghost `REGION` to `COUNTRY` 2021-09-23 13:28:32 +00:00			- `REGION` for PIA, Cyberghost
Doc: update maintenance document 2021-09-16 20:42:39 +00:00			- `WIREGUARD_ADDRESS`
			- `VPNSP`
			- All old location filters such as `REGION`, `COUNTRY`, etc.
			`- Remove other retro logic`
			- `VPNSP`'s `pia = private ...`
			- Remove `OPENVPN_CONFIG` != "" implies `VPNSP` = "custom" AND set `OPENVPN_CUSTOM_CONFIG` default to `/gluetun/custom.ovpn`
			`- Remove functionalities`
			- `SERVER_NUMBER`
docs(maintenance): update document 2022-04-16 21:08:49 +00:00			- `SERVER_NAME`
Doc: update maintenance document 2021-09-16 20:42:39 +00:00			- `PUBLICIP_FILE`
feat(env): rename vpn port forwarding variables - `VPN_PORT_FORWARDING_STATUS_FILE` - `VPN_PORT_FORWARDING` - Deprecate PIA specific variables for VPN port forwarding 2023-04-27 10:22:23 +00:00			- `PORT_FORWARDING_STATUS_FILE`, `PRIVATE_INTERNET_ACCESS_VPN_PORT_FORWARDING_STATUS_FILE`
Doc: maintenance document 2021-06-22 14:42:15 +00:00			`- Updater servers version reset to 1`
docs(maintenance): update document 2022-04-16 21:08:49 +00:00			`- Reset HTTP server version to v1 and remove older ones`
Doc: update maintenance document 2021-09-16 20:42:39 +00:00			`- Change to compulsory`
			- `VPN_SERVICE_PROVIDER`
`VPNSP` value `custom` for OpenVPN custom config files (#621) - Retro-compatibility: `OPENVPN_CUSTOM_CONFIG` set implies `VPNSP=custom` - Change: `up` and `down` options are not filtered out - Change: `OPENVPN_INTERFACE` overrides the network interface defined in the configuration file - Change: `PORT` overrides any port found in the configuration file - Feat: config file is read when building the OpenVPN configuration, so it's effectively reloaded on VPN restarts - Feat: extract values from custom file at start to log out valid settings - Maint: `internal/openvpn/extract` package instead of `internal/openvpn/custom` package - Maint: All providers' `BuildConf` method return an error - Maint: rename `CustomConfig` to `ConfFile` in Settings structures 2021-09-13 11:30:14 -04:00			`- Use relative paths everywhere instead of absolute`