vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #1105 from Dibins/patch-1

Browse Source 
Update dns.rst
This commit is contained in:
Robert Göhler 2023-10-05 22:25:10 +02:00 committed by GitHub
commit c6737c7213
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 34 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
docs/configuration/service/dns.rst
View File

@ -216,36 +216,36 @@ Configuration
:rfc:`2136` Based :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 Create new :rfc:`2136` DNS update configuration which will update the IP
address assigned to `<interface>` on the service you configured under address assigned to `<interface>` on the service you configured under
`<service-name>`. `<service-name>`.
.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name> .. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
key <keyfile> key <keyfile>
File identified by `<keyfile>` containing the secret RNDC key shared with File identified by `<keyfile>` containing the secret RNDC key shared with
remote DNS server. 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> server <server>
Configure the DNS `<server>` IP/FQDN used when updating this dynamic Configure the DNS `<server>` IP/FQDN used when updating this dynamic
assignment. assignment.
.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name> .. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
zone <zone> zone <zone>
Configure DNS `<zone>` to be updated. 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> record <record>
Configure DNS `<record>` which should be updated. This can be set multiple Configure DNS `<record>` which should be updated. This can be set multiple
times. times.
.. cfgcmd:: set service dns dynamic interface <interface> rfc2136 <service-name> .. cfgcmd:: set service dns dynamic address <interface> rfc2136 <service-name>
ttl <ttl> ttl <ttl>
Configure optional TTL value on the given resource record. This defaults to Configure optional TTL value on the given resource record. This defaults to
@ -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 To use such a service, one must define a login, password, one or multiple
hostnames, protocol and server. 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> host-name <hostname>
Setup the dynamic DNS hostname `<hostname>` associated with the DynDNS 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. `<interface>` changes.
.. cfgcmd:: set service dns dynamic interface <interface> service <service> .. cfgcmd:: set service dns dynamic address <interface> service <service>
login <username> username <username>
Configure `<username>` used when authenticating the update request for Configure `<username>` used when authenticating the update request for
DynDNS service identified by `<service>`. DynDNS service identified by `<service>`.
For Namecheap, set the <domain> you wish to update. 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> password <password>
Configure `<password>` used when authenticating the update request for Configure `<password>` used when authenticating the update request for
DynDNS service identified by `<service>`. 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> protocol <protocol>
When a ``custom`` DynDNS provider is used the protocol used for communicating When a ``custom`` DynDNS provider is used the protocol used for communicating
to the provider must be specified under `<protocol>`. See the embedded to the provider must be specified under `<protocol>`. See the embedded
completion helper for available protocols. 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> server <server>
When a ``custom`` DynDNS provider is used the `<server>` where update When a ``custom`` DynDNS provider is used the `<server>` where update
requests are being sent to must be specified. 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. Allow explicit IPv6 address for the interface.
@ -353,10 +353,10 @@ Use DynDNS as your preferred provider:
.. code-block:: none .. code-block:: none
set service dns dynamic interface eth0 service dyndns set service dns dynamic address eth0 service dyndns
set service dns dynamic interface eth0 service dyndns login my-login set service dns dynamic address eth0 service dyndns username my-login
set service dns dynamic interface eth0 service dyndns password my-password set service dns dynamic address 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 host-name my-dyndns-hostname
.. note:: Multiple services can be used per interface. Just specify as many .. note:: Multiple services can be used per interface. Just specify as many
services per interface as you like! services per interface as you like!
@ -366,12 +366,12 @@ Example IPv6 only:
.. code-block:: none .. code-block:: none
set service dns dynamic interface eth0 ipv6-enable set service dns dynamic address eth0 ipv6-enable
set service dns dynamic interface eth0 service dyndns6 login my-login set service dns dynamic address eth0 service dyndns6 username my-login
set service dns dynamic interface eth0 service dyndns6 password my-password set service dns dynamic address eth0 service dyndns6 password my-password
set service dns dynamic interface eth0 service dyndns6 host-name my-dyndns-hostname set service dns dynamic address eth0 service dyndns6 host-name my-dyndns-hostname
set service dns dynamic interface eth0 service dyndns6 protocol dyndns2 set service dns dynamic address eth0 service dyndns6 protocol dyndns2
set service dns dynamic interface eth0 service dyndns6 server dyndns-v6-server set service dns dynamic address eth0 service dyndns6 server dyndns-v6-server
Running Behind NAT Running Behind NAT
@ -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 directly attached to the interface. If your VyOS instance is behind NAT, your
record will be updated to point to your internal IP. record will be updated to point to your internal IP.
ddclient_ has another way to determine the WAN IP address. This is controlled Above, command syntax isn noted to configure dynamic dns on a specific interface.
by: 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 Use configured `<url>` to determine your IP address. ddclient_ will load
`<url>` and tries to extract your IP address from the response. `<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>`. ddclient_ will skip any address located before the string set in `<pattern>`.