AIVPN icon indicating copy to clipboard operation
AIVPN copied to clipboard

Discrepancy in config.ini.example and docs

Open ay-bh opened this issue 2 years ago • 0 comments

Describe the bug There's an inconsistency in the documentation and the example configuration file for AIVPN regarding the protocol used in the SERVER_PUBLIC_URL for both OpenVPN and WireGuard services. Specifically, the documentation instructs to use TCP for OpenVPN and UDP for WireGuard, while the example config file (config.ini.example) has these protocols swapped: it lists OpenVPN with UDP and WireGuard with TCP.

To Reproduce Steps to reproduce the behavior:

  1. Visit the AIVPN documentation page.
  2. Note the instructions for setting up the OpenVPN and WireGuard VPN configurations, which specify using TCP for OpenVPN and UDP for WireGuard.
  3. Compare with the config.ini.example file. (Line 48 & 54)
  4. Observe the discrepancy in the SERVER_PUBLIC_URL protocol specification: UDP is mentioned for OpenVPN and TCP for WireGuard in the example config file, contrary to the documentation.

Expected behavior The documentation and the example configuration file should consistently specify the correct protocols to be used for OpenVPN and WireGuard in the SERVER_PUBLIC_URL

Screenshots Screenshot 2024-03-12 at 10 37 24 PM Screenshot 2024-03-12 at 11 06 20 PM

ay-bh avatar Mar 12 '24 17:03 ay-bh