[Openvpn-devel] man: extend description for "dhcp-option DNS" on Windows

Message ID 20230905211357.581-1-a@unstable.cc
State New
Headers show
Series [Openvpn-devel] man: extend description for "dhcp-option DNS" on Windows | expand

Commit Message

Antonio Quartulli Sept. 5, 2023, 9:13 p.m. UTC
From: Antonio Quartulli <antonio@mandelbit.com>

Add an important detail about the DNS configured via this option
to be an "interface-specific" DNS. This detail is important when
troubleshooting DNS issues since this logic will bypass the
routing table.

Signed-off-by: Antonio Quartulli <antonio@mandelbit.com>
 doc/man-sections/vpn-network-options.rst | 6 ++++++
 1 file changed, 6 insertions(+)


diff --git a/doc/man-sections/vpn-network-options.rst b/doc/man-sections/vpn-network-options.rst
index b7f33acd..17c7d4a2 100644
--- a/doc/man-sections/vpn-network-options.rst
+++ b/doc/man-sections/vpn-network-options.rst
@@ -158,6 +158,12 @@  routing.
         Set primary domain name server IPv4 or IPv6 address.
         Repeat this option to set secondary DNS server addresses.
+        On Windows this option sets an "interface-specific" DNS, meaning
+        that the system will try to reach it via the VPN interface, no
+        matter what the routing table says. If the wanted DNS is not
+        expected to be reached via VPN, please don't use this option, but
+        rather set the DNS manually (or via DHCP).
         Note: DNS IPv6 servers are currently set using netsh (the existing
         DHCP code can only do IPv4 DHCP, and that protocol only permits
         IPv4 addresses anywhere). The option will be put into the