diff options
| -rw-r--r-- | docs/install.rst | 6 | ||||
| -rw-r--r-- | docs/system/config-management.rst | 32 | ||||
| -rw-r--r-- | docs/system/index.rst | 2 | ||||
| -rw-r--r-- | docs/system/system-dns.rst | 68 |
4 files changed, 72 insertions, 36 deletions
diff --git a/docs/install.rst b/docs/install.rst index a0455404..87be9561 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -47,7 +47,7 @@ https://downloads.vyos.io/ .. note:: Rolling releases contain all the latest enhancements and fixes. This means that there will be new bugs of course. If you think you hit a bug - please follow the guide at :ref:`bug_report`. To improve VyOS we depend on + please follow the guide at :ref:`issues_features`. To improve VyOS we depend on your feedback! The following link will always fetch the most recent VyOS build for AMD64 @@ -347,8 +347,8 @@ installation method which allows deploying VyOS through the network. **Requirements** * Clients (where VyOS is to be installed) with a PXE-enabled NIC -* :ref:`dhcp-server` -* :ref:`tftp-server` +* DHCP Server +* TFTP Server * Webserver (HTTP) - optional, but we will use it to speed up installation * VyOS ISO image to be installed (do not use images prior to VyOS 1.2.3) * Files *pxelinux.0* and *ldlinux.c32* `from the Syslinux distribution <https://kernel.org/pub/linux/utils/boot/syslinux/>`_ diff --git a/docs/system/config-management.rst b/docs/system/config-management.rst deleted file mode 100644 index b8c1d309..00000000 --- a/docs/system/config-management.rst +++ /dev/null @@ -1,32 +0,0 @@ -.. _config-management: - -######################## -Configuration Management -######################## - -VyOS comes with an integrated versioning system for the system configuration. -The configurations are versioned locally for rollback but they can also be -stored on a remote host for archiving/backup reasons. - -.. cfgcmd:: set system config-management commit-revisions <number> - -Change the number of commit revisions to `<number>`, the default setting for -this value is to store 20 revisions locally. - - -.. cfgcmd:: set system config-management commit-archive location '<url>' - -If you want to save all config changes to a remote destination. Set the -commit-archive location. Every time a commit is successfully the ``config.boot`` -file will be copied to the defined destination(s). The filename used on the -remote host used will be: ``config.boot-hostname.YYYYMMDD_HHMMSS`` - -Destinations will be configured as any of the below :abbr:`URI (Uniform -Resource Identifier)` - -* ``scp://<user>:<passwd>@<host>/<dir>`` -* ``sftp://<user>:<passwd>@<host>/<dir>`` -* ``ftp://<user>:<passwd>@<host>/<dir>`` -* ``tftp://<host>/<dir>`` - -.. note:: The number of revisions don't effect the commit-archive.
\ No newline at end of file diff --git a/docs/system/index.rst b/docs/system/index.rst index 0a51e23c..a0d470aa 100644 --- a/docs/system/index.rst +++ b/docs/system/index.rst @@ -11,7 +11,6 @@ should be ready for further configuration which is described in this chapter. :maxdepth: 2 :hidden: - config-management eventhandler flowaccounting host-information @@ -20,6 +19,7 @@ should be ready for further configuration which is described in this chapter. proxy serialconsole syslog + system-dns task-scheduler time-zone boot-options diff --git a/docs/system/system-dns.rst b/docs/system/system-dns.rst new file mode 100644 index 00000000..70848f6d --- /dev/null +++ b/docs/system/system-dns.rst @@ -0,0 +1,68 @@ +.. _system-dns: + +########## +System DNS +########## + + +This section describes configuring DNS on the system, namely: + + * DNS name servers + * Domain search order + + +DNS name servers +================ + +.. cfgcmd:: set system name-server <address> + + Use this command to specify a DNS server for the system to be used + for DNS lookups. More than one DNS server can be added, configuring + one at a time. Both IPv4 and IPv6 addresses are supported. + + + +Example +------- + +In this example, some *OpenNIC* servers are used, two IPv4 addresses +and two IPv6 addresses: + + +.. code-block:: none + + set system name-server 176.9.37.132 + set system name-server 195.10.195.195 + set system name-server 2a01:4f8:161:3441::1 + set system name-server 2a00:f826:8:2::195 + + +Domain search order +=================== + +In order for the system to use and complete unqualified host names, a +list can be defined which will be used for domain searches. + + +.. cfgcmd:: set system domain-search domain <domain> + + Use this command to define domains, one at a time, so that the system + uses them to complete unqualified host names. Maximum: 6 entries. + + +.. note:: Domain names can include letters, numbers, hyphens and periods + with a maximum length of 253 characters. + + +Example +------- + +The system is configured to attempt domain completion in the following +order: vyos.io (first), vyos.net (second) and vyos.network (last): + + +.. code-block:: none + + set system domain-search domain vyos.io + set system domain-search domain vyos.net + set system domain-search domain vyos.network |