From d92feb4cc4808632b7273ff5c546dd36b4ce5331 Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 02:31:39 +0000 Subject: docs(interface-xdp.txt): change XDP available version to 1.4 the configuration node for XDP was removed in 1.3 - see https://github.com/vyos/vyos-1x/commit/801c523502e5594da4796854d0ea2ecdd2d04958 T2666 --- docs/_include/interface-xdp.txt | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_include/interface-xdp.txt b/docs/_include/interface-xdp.txt index d87151fc..34b46bdf 100644 --- a/docs/_include/interface-xdp.txt +++ b/docs/_include/interface-xdp.txt @@ -1,6 +1,6 @@ .. cfgcmd:: set interfaces {{ var0 }} xdp - Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.3 rolling + Enable support for Linux :abbr:`XDP (eXpress Data Path)` on recent 1.4 rolling releases. You must enable it for every interface which should participate in the XDP forwarding. @@ -24,4 +24,4 @@ .. code-block:: none - set interfaces {{ var0 }} {{ var1 }} xdp \ No newline at end of file + set interfaces {{ var0 }} {{ var1 }} xdp -- cgit v1.2.3 From 7b5275e402468ad95e46eee154767d33e93f7733 Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 02:37:45 +0000 Subject: docs(interface-ip.txt): clarify wording of note --- docs/_include/interface-ip.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_include/interface-ip.txt b/docs/_include/interface-ip.txt index 89937806..abbed529 100644 --- a/docs/_include/interface-ip.txt +++ b/docs/_include/interface-ip.txt @@ -126,7 +126,7 @@ possible to allow these hosts to communicate through the upstream router by proxy_arp'ing. - .. note:: Don't need to be used together with proxy_arp. + .. note:: Does not need to be used together with proxy_arp. This technology is known by different names: -- cgit v1.2.3 From 81cc2a130be1e755f4029322f6f4f189443c5cec Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 02:51:46 +0000 Subject: docs(snmp.rst): clean up grammar --- docs/configuration/service/snmp.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst index e962c1c5..80328c7b 100644 --- a/docs/configuration/service/snmp.rst +++ b/docs/configuration/service/snmp.rst @@ -201,7 +201,7 @@ VyOS MIBs All SNMP MIBs are located in each image of VyOS here: ``/usr/share/snmp/mibs/`` -you are be able to download the files with the a activate ssh service like this +You are be able to download the files using SCP, once the SSH service has been activated like so .. code-block:: none @@ -270,4 +270,4 @@ following content: .. _SNMPv2: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_2 .. _SNMPv3: https://en.wikipedia.org/wiki/Simple_Network_Management_Protocol#Version_3 -.. start_vyoslinter \ No newline at end of file +.. start_vyoslinter -- cgit v1.2.3 From a64b363a891cc0302948fede2e65af4766af305f Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 02:54:26 +0000 Subject: docs(ssh.rst): clarity of sentence --- docs/configuration/service/ssh.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/service/ssh.rst b/docs/configuration/service/ssh.rst index 94249766..c6d0d1e0 100644 --- a/docs/configuration/service/ssh.rst +++ b/docs/configuration/service/ssh.rst @@ -127,8 +127,8 @@ Operation .. opcmd:: generate ssh client-key /path/to/private_key - Re-generated a known pub/private keyfile which can e.g. used to connect to - other services (RPKI cache). + Re-generated a known pub/private keyfile which can be used to connect to + other services (e.g. RPKI cache). Example: -- cgit v1.2.3 From e8a7024328693651e30b57b307c2271e898aee14 Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 02:56:19 +0000 Subject: docs(tftp-server.rst): grammar corrections --- docs/configuration/service/tftp-server.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/service/tftp-server.rst b/docs/configuration/service/tftp-server.rst index 276ce5fb..76df6a10 100644 --- a/docs/configuration/service/tftp-server.rst +++ b/docs/configuration/service/tftp-server.rst @@ -32,7 +32,7 @@ on each IP address. .. cfgcmd:: set service tftp-server allow-upload -Optional, if you want to enable uploads, else TFTP server will act as read-only +Optional, if you want to enable uploads, else TFTP server will act as a read-only server. Example @@ -40,7 +40,7 @@ Example Provide TFTP server listening on both IPv4 and IPv6 addresses ``192.0.2.1`` and ``2001:db8::1`` serving the content from ``/config/tftpboot``. Uploading via -TFTP to this server is not allowed! +TFTP to this server is disabled. The resulting configuration will look like: -- cgit v1.2.3 From dade86a7b78cfd83878ac98d1f79e2ded77605f3 Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 03:02:59 +0000 Subject: docs(option.rst): make use of cURL project accurate and consistent --- docs/configuration/system/option.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/configuration/system/option.rst b/docs/configuration/system/option.rst index e029ec96..8e314029 100644 --- a/docs/configuration/system/option.rst +++ b/docs/configuration/system/option.rst @@ -28,8 +28,8 @@ HTTP client .. cfgcmd:: set system option http-client source-address
- Several commands utilize curl to initiate transfers. Configure the local - source IPv4/IPv6 address used for all CURL operations. + Several commands utilize cURL to initiate transfers. Configure the local + source IPv4/IPv6 address used for all cURL operations. .. cfgcmd:: set system option http-client source-interface -- cgit v1.2.3 From 1039dc47f2d86a9b0e9388b0566da0f9fc8a89fa Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 03:03:47 +0000 Subject: docs(option.rst): correct German to English --- docs/configuration/system/option.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuration/system/option.rst b/docs/configuration/system/option.rst index 8e314029..a4e08245 100644 --- a/docs/configuration/system/option.rst +++ b/docs/configuration/system/option.rst @@ -54,7 +54,7 @@ the used keyboard layout on the system console. Defaults to ``us``. .. note:: Changing the keymap only has an effect on the system console, using - SSH oder Serial remote access to the device is not affected as the keyboard + SSH or Serial remote access to the device is not affected as the keyboard layout here corresponds to your access system. .. _system_options_performance: -- cgit v1.2.3 From 93e2f6a9620d315b1e0e1b4d4d389deaf83812e6 Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 03:24:12 +0000 Subject: docs: fix linting errors --- docs/configuration/service/snmp.rst | 3 ++- docs/configuration/service/ssh.rst | 3 ++- docs/configuration/service/tftp-server.rst | 4 ++-- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst index 80328c7b..4a5a2780 100644 --- a/docs/configuration/service/snmp.rst +++ b/docs/configuration/service/snmp.rst @@ -201,7 +201,8 @@ VyOS MIBs All SNMP MIBs are located in each image of VyOS here: ``/usr/share/snmp/mibs/`` -You are be able to download the files using SCP, once the SSH service has been activated like so +You are be able to download the files using SCP, once the SSH service +has been activated like so .. code-block:: none diff --git a/docs/configuration/service/ssh.rst b/docs/configuration/service/ssh.rst index c6d0d1e0..6b09d40d 100644 --- a/docs/configuration/service/ssh.rst +++ b/docs/configuration/service/ssh.rst @@ -153,5 +153,6 @@ Operation | =.. o=.oo| +----[SHA256]-----+ - Two new files ``/config/auth/id_rsa_rpki`` and ``/config/auth/id_rsa_rpki.pub`` + Two new files ``/config/auth/id_rsa_rpki`` and + ``/config/auth/id_rsa_rpki.pub`` will be created. diff --git a/docs/configuration/service/tftp-server.rst b/docs/configuration/service/tftp-server.rst index 76df6a10..d220d789 100644 --- a/docs/configuration/service/tftp-server.rst +++ b/docs/configuration/service/tftp-server.rst @@ -32,8 +32,8 @@ on each IP address. .. cfgcmd:: set service tftp-server allow-upload -Optional, if you want to enable uploads, else TFTP server will act as a read-only -server. +Optional, if you want to enable uploads, else TFTP server will act as a +read-only server. Example ------- -- cgit v1.2.3 From a0154149dd448be158e356fa8ae8b6595e6bd35b Mon Sep 17 00:00:00 2001 From: "Daniel T. Thorpe" Date: Thu, 11 Feb 2021 03:34:06 +0000 Subject: docs(interface-xdp.txt): fix linting error --- docs/_include/interface-xdp.txt | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/_include/interface-xdp.txt b/docs/_include/interface-xdp.txt index 34b46bdf..e28db88d 100644 --- a/docs/_include/interface-xdp.txt +++ b/docs/_include/interface-xdp.txt @@ -18,7 +18,9 @@ nftables. Enabling this feature will only load the XDP router code as described here: + .. stop_vyoslinter https://blog.apnic.net/2020/04/30/how-to-build-an-xdp-based-bgp-peering-router/ + .. start_vyoslinter Example: -- cgit v1.2.3