From cf1c7eb76d253ff800390fee852c2f320f9c355a Mon Sep 17 00:00:00 2001 From: Shnoobins Date: Mon, 2 Oct 2023 12:40:37 -0500 Subject: Update dns.rst Updated command syntax for dynamic dns - changed set service dns dynamic interface to set service dns dynamic address. Changed the login option from 'login' to 'username' Changed the web options from 'use-web' to 'web-options' Changed because I ran into the command syntax change on a 1.4 install. Updating documents to match. --- docs/configuration/service/dns.rst | 40 +++++++++++++++++++------------------- 1 file changed, 20 insertions(+), 20 deletions(-) (limited to 'docs') diff --git a/docs/configuration/service/dns.rst b/docs/configuration/service/dns.rst index c96c0ab4..adc58d8e 100644 --- a/docs/configuration/service/dns.rst +++ b/docs/configuration/service/dns.rst @@ -308,40 +308,40 @@ VyOS is also able to use any service relying on protocols supported by ddclient. To use such a service, one must define a login, password, one or multiple hostnames, protocol and server. -.. cfgcmd:: set service dns dynamic interface service +.. cfgcmd:: set service dns dynamic address service host-name Setup the dynamic DNS hostname `` associated with the DynDNS - provider identified by `` when the IP address on interface + provider identified by `` when the IP address on address `` changes. -.. cfgcmd:: set service dns dynamic interface service - login +.. cfgcmd:: set service dns dynamic address service + username Configure `` used when authenticating the update request for DynDNS service identified by ``. For Namecheap, set the you wish to update. -.. cfgcmd:: set service dns dynamic interface service +.. cfgcmd:: set service dns dynamic address service password Configure `` used when authenticating the update request for DynDNS service identified by ``. -.. cfgcmd:: set service dns dynamic interface service +.. cfgcmd:: set service dns dynamic address service protocol When a ``custom`` DynDNS provider is used the protocol used for communicating to the provider must be specified under ``. See the embedded completion helper for available protocols. -.. cfgcmd:: set service dns dynamic interface service +.. cfgcmd:: set service dns dynamic address service server When a ``custom`` DynDNS provider is used the `` where update requests are being sent to must be specified. -.. cfgcmd:: set service dns dynamic interface ipv6-enable +.. cfgcmd:: set service dns dynamic address ipv6-enable Allow explicit IPv6 address for the interface. @@ -353,10 +353,10 @@ Use DynDNS as your preferred provider: .. code-block:: none - set service dns dynamic interface eth0 service dyndns - set service dns dynamic interface eth0 service dyndns login my-login - set service dns dynamic interface eth0 service dyndns password my-password - set service dns dynamic interface eth0 service dyndns host-name my-dyndns-hostname + set service dns dynamic address eth0 service dyndns + set service dns dynamic address eth0 service dyndns username my-login + set service dns dynamic address eth0 service dyndns password my-password + set service dns dynamic address eth0 service dyndns host-name my-dyndns-hostname .. note:: Multiple services can be used per interface. Just specify as many services per interface as you like! @@ -366,12 +366,12 @@ Example IPv6 only: .. code-block:: none - set service dns dynamic interface eth0 ipv6-enable - set service dns dynamic interface eth0 service dyndns6 login my-login - set service dns dynamic interface eth0 service dyndns6 password my-password - set service dns dynamic interface eth0 service dyndns6 host-name my-dyndns-hostname - set service dns dynamic interface eth0 service dyndns6 protocol dyndns2 - set service dns dynamic interface eth0 service dyndns6 server dyndns-v6-server + set service dns dynamic address eth0 ipv6-enable + set service dns dynamic address eth0 service dyndns6 username my-login + set service dns dynamic address eth0 service dyndns6 password my-password + set service dns dynamic address eth0 service dyndns6 host-name my-dyndns-hostname + set service dns dynamic address eth0 service dyndns6 protocol dyndns2 + set service dns dynamic address eth0 service dyndns6 server dyndns-v6-server Running Behind NAT @@ -384,12 +384,12 @@ record will be updated to point to your internal IP. ddclient_ has another way to determine the WAN IP address. This is controlled by: -.. cfgcmd:: set service dns dynamic interface use-web url +.. cfgcmd:: set service dns dynamic address web-options url Use configured `` to determine your IP address. ddclient_ will load `` and tries to extract your IP address from the response. -.. cfgcmd:: set service dns dynamic interface use-web skip +.. cfgcmd:: set service dns dynamic address web-options skip ddclient_ will skip any address located before the string set in ``. -- cgit v1.2.3 From fa84bc4b3513a7ae42ea30346ac41ac6ed6f16db Mon Sep 17 00:00:00 2001 From: Dibins <6020646+Dibins@users.noreply.github.com> Date: Mon, 2 Oct 2023 16:53:29 -0500 Subject: Second update dns.rst Based on the discussion here: https://forum.vyos.io/t/dynamic-dns-not-wollowing-web-options/12309 it seems necessary to note that setting the web-options on a given interface is not sufficient for determining the IP address when behind NAT. I've added some additional detail, which I think will make that more clear, as well as listed the commands as required to set up DDNS behind NAT. Further I updated the section on RFC2136 to accurately show address instead of interface --- docs/configuration/service/dns.rst | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) (limited to 'docs') diff --git a/docs/configuration/service/dns.rst b/docs/configuration/service/dns.rst index adc58d8e..2caeb22d 100644 --- a/docs/configuration/service/dns.rst +++ b/docs/configuration/service/dns.rst @@ -216,36 +216,36 @@ Configuration :rfc:`2136` Based ----------------- -.. cfgcmd:: set service dns dynamic interface rfc2136 +.. cfgcmd:: set service dns dynamic address rfc2136 Create new :rfc:`2136` DNS update configuration which will update the IP address assigned to `` on the service you configured under ``. -.. cfgcmd:: set service dns dynamic interface rfc2136 +.. cfgcmd:: set service dns dynamic address rfc2136 key File identified by `` containing the secret RNDC key shared with remote DNS server. -.. cfgcmd:: set service dns dynamic interface rfc2136 +.. cfgcmd:: set service dns dynamic address rfc2136 server Configure the DNS `` IP/FQDN used when updating this dynamic assignment. -.. cfgcmd:: set service dns dynamic interface rfc2136 +.. cfgcmd:: set service dns dynamic address rfc2136 zone Configure DNS `` to be updated. -.. cfgcmd:: set service dns dynamic interface rfc2136 +.. cfgcmd:: set service dns dynamic address rfc2136 record Configure DNS `` which should be updated. This can be set multiple times. -.. cfgcmd:: set service dns dynamic interface rfc2136 +.. cfgcmd:: set service dns dynamic address rfc2136 ttl Configure optional TTL value on the given resource record. This defaults to @@ -381,15 +381,21 @@ By default, ddclient_ will update a dynamic dns record using the IP address directly attached to the interface. If your VyOS instance is behind NAT, your record will be updated to point to your internal IP. -ddclient_ has another way to determine the WAN IP address. This is controlled -by: +Above, command syntax isn noted to configure dynamic dns on a specific interface. +It is possible to overlook the additional address option, web, when completeing +those commands. ddclient_ has another way to determine the WAN IP address, using +a web-based url to determine the external IP. Each of the commands above will +need to be modified to use 'web' as the 'interface' specified if this functionality +is to be utilized. -.. cfgcmd:: set service dns dynamic address web-options url +This functionality is controlled by adding the following configuration: + +.. cfgcmd:: set service dns dynamic address web web-options url Use configured `` to determine your IP address. ddclient_ will load `` and tries to extract your IP address from the response. -.. cfgcmd:: set service dns dynamic address web-options skip +.. cfgcmd:: set service dns dynamic address web web-options skip ddclient_ will skip any address located before the string set in ``. -- cgit v1.2.3