Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update dns.rst #1105

Merged
merged 2 commits into from
Oct 5, 2023
Merged

Update dns.rst #1105

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cf1c7eb
Update dns.rst
Oct 2, 2023
fa84bc4
Second update dns.rst
Dibins Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
62 changes: 34 additions & 28 deletions docs/configuration/service/dns.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,36 +216,36 @@ Configuration
:rfc:`2136` Based
-----------------

.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name>
.. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>

Create new :rfc:`2136` DNS update configuration which will update the IP
address assigned to `<interface>` on the service you configured under
`<service-name>`.

.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name>
.. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
key <keyfile>

File identified by `<keyfile>` containing the secret RNDC key shared with
remote DNS server.

.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name>
.. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
server <server>

Configure the DNS `<server>` IP/FQDN used when updating this dynamic
assignment.

.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name>
.. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
zone <zone>

Configure DNS `<zone>` to be updated.

.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name>
.. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
record <record>

Configure DNS `<record>` which should be updated. This can be set multiple
times.

.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name>
.. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
ttl <ttl>

Configure optional TTL value on the given resource record. This defaults to
Expand Down Expand Up @@ -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 <interface> service <service>
.. cfgcmd:: set service dns dynamic address <interface> service <service>
host-name <hostname>

Setup the dynamic DNS hostname `<hostname>` associated with the DynDNS
provider identified by `<service>` when the IP address on interface
provider identified by `<service>` when the IP address on address
`<interface>` changes.

.. cfgcmd:: set service dns dynamic interface <interface> service <service>
login <username>
.. cfgcmd:: set service dns dynamic address <interface> service <service>
username <username>

Configure `<username>` used when authenticating the update request for
DynDNS service identified by `<service>`.
For Namecheap, set the <domain> you wish to update.

.. cfgcmd:: set service dns dynamic interface <interface> service <service>
.. cfgcmd:: set service dns dynamic address <interface> service <service>
password <password>

Configure `<password>` used when authenticating the update request for
DynDNS service identified by `<service>`.

.. cfgcmd:: set service dns dynamic interface <interface> service <service>
.. cfgcmd:: set service dns dynamic address <interface> service <service>
protocol <protocol>

When a ``custom`` DynDNS provider is used the protocol used for communicating
to the provider must be specified under `<protocol>`. See the embedded
completion helper for available protocols.

.. cfgcmd:: set service dns dynamic interface <interface> service <service>
.. cfgcmd:: set service dns dynamic address <interface> service <service>
server <server>

When a ``custom`` DynDNS provider is used the `<server>` where update
requests are being sent to must be specified.

.. cfgcmd:: set service dns dynamic interface <interface> ipv6-enable
.. cfgcmd:: set service dns dynamic address <interface> ipv6-enable

Allow explicit IPv6 address for the interface.

Expand All @@ -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!
Expand All @@ -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
Expand All @@ -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 interface <interface> use-web url <url>
This functionality is controlled by adding the following configuration:

.. cfgcmd:: set service dns dynamic address web web-options url <url>

Use configured `<url>` to determine your IP address. ddclient_ will load
`<url>` and tries to extract your IP address from the response.

.. cfgcmd:: set service dns dynamic interface <interface> use-web skip <pattern>
.. cfgcmd:: set service dns dynamic address web web-options skip <pattern>

ddclient_ will skip any address located before the string set in `<pattern>`.

Expand Down