summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniil Baturin <daniil@vyos.io>2021-08-01 18:18:14 +0700
committerGitHub <noreply@github.com>2021-08-01 18:18:14 +0700
commit740074af7aa370c63b1f4e9617dbf251a9610a37 (patch)
tree55f919804470674f1f629fece7382becabe11672
parent7fe53c9d60cb29890e71735acf882e96cb83a36b (diff)
parent9eb90286c0ca7712e1f55812a5affb18facd8293 (diff)
downloadvyos-documentation-740074af7aa370c63b1f4e9617dbf251a9610a37.tar.gz
vyos-documentation-740074af7aa370c63b1f4e9617dbf251a9610a37.zip
Merge pull request #585 from srividya0208/proof-reading
grammar correction
-rw-r--r--docs/commandtree/configmode.rst92
-rw-r--r--docs/configuration/interfaces/openvpn.rst35
-rw-r--r--docs/installation/migrate-from-vyatta.rst4
3 files changed, 88 insertions, 43 deletions
diff --git a/docs/commandtree/configmode.rst b/docs/commandtree/configmode.rst
index d4148c22..3e398d5a 100644
--- a/docs/commandtree/configmode.rst
+++ b/docs/commandtree/configmode.rst
@@ -34,8 +34,10 @@ The ``confirm`` command confirms the prior ``commit-confirm``.
Comment
^^^^^^^
-The ``comment`` commands allow you to insert a comment above the current configuration section.
-The command cannot be used at the top of the configuration hierarchy, only on subsections. Comments needs to be commited, just like other config changes.
+The ``comment`` commands allow you to insert a comment above the current
+configuration section.
+The command cannot be used at the top of the configuration hierarchy, only on
+subsections. Comments need to be commited, just like other config changes.
To add a comment to a section, while being already at the proper section level:
@@ -84,7 +86,10 @@ The comment would then appear like this:
[...]
-An important thing to note is that since the comment is added on top of the section, it will not appear if the ``show <section>`` command is used. With the above example, the ``show interfaces`` command would return starting after the "interfaces {" line, hiding the comment:
+An important thing to note is that since the comment is added on top of the
+section, it will not appear if the ``show <section>`` command is used. With the
+above example, the ``show interfaces`` command would return starting after the
+"interfaces {" line, hiding the comment:
.. code-block:: none
@@ -102,7 +107,8 @@ To add a comment to the interfaces section from the top:
vyos@vyos# comment interfaces "test"
-The comment can be added to any node that already exists, even if it's multiple levels lower:
+The comment can be added to any node that already exists, even if it's multiple
+levels lower:
.. code-block:: none
@@ -114,10 +120,15 @@ Commit
^^^^^^
The ``commit`` command commits the proposed changes to the configuration file.
-Every changes done in the configuration session is only applied when the configuration is committed. To view the changes that will be applied, use the show command.
-To discard the changes without committing, use the ``discard`` command. The ``commit`` command doesn't save the configuration, you need to manually use the ``save`` command.
+Every changes done in the configuration session is only applied when the
+configuration is committed. To view the changes that will be applied, use the
+show command.
+To discard the changes without committing, use the ``discard`` command. The
+``commit`` command doesn't save the configuration, you need to manually use the
+``save`` command.
-The confirm keyword can be added, see ``commit-confirm``. A comment can be entered, it will appear in the commit log.
+The confirm keyword can be added, see ``commit-confirm``. A comment can be
+entered, it will appear in the commit log.
.. code-block:: none
@@ -130,8 +141,10 @@ The confirm keyword can be added, see ``commit-confirm``. A comment can be enter
Commit-confirm
^^^^^^^^^^^^^^
-The ``commit-confirm`` command commits the proposed changes to the configuration file and starts a timer.
-If the ``confirm`` command is not entered before the timer expiration, the configuration will be rolled back and VyOS will reboot.
+The ``commit-confirm`` command commits the proposed changes to the
+configuration file and starts a timer.
+If the ``confirm`` command is not entered before the timer expiration, the
+configuration will be rolled back and VyOS will reboot.
The default timer value is 10 minutes, but a custom value can be entered.
.. code-block:: none
@@ -147,7 +160,8 @@ The default timer value is 10 minutes, but a custom value can be entered.
Compare
^^^^^^^
-VyOS maintains backups of previous configurations. To compare configuration revisions in configuration mode, use the compare command:
+VyOS maintains backups of previous configurations. To compare configuration
+revisions in configuration mode, use the compare command:
.. code-block:: none
@@ -176,7 +190,7 @@ Copy
The ``copy`` command allows you to copy a configuration object.
-Copy the configuration entrys from a firewall name WAN rule 1 to rule 2.
+Copy the configuration entries from a firewall name WAN rule 1 to rule 2.
.. code-block:: none
@@ -208,9 +222,9 @@ Copy the configuration entrys from a firewall name WAN rule 1 to rule 2.
Delete
^^^^^^
-The ``delte`` command is to delete a configuration entry.
+The ``delete`` command is to delete a configuration entry.
-This Example delete the hole ``service tftp-server`` section.
+This example deletes the whole ``service tftp-server`` section.
.. code-block:: none
@@ -232,8 +246,10 @@ Edit
^^^^
The ``edit`` command allows you to navigate down into the configuration tree.
-To get back to an upper level, use the ``up`` command or use the ``top`` command to get back to the upper most level.
-The ``[edit]`` text displays where the user is located in the configuration tree.
+To get back to an upper level, use the ``up`` command or use the ``top``
+command to get back to the upper most level.
+The ``[edit]`` text displays where the user is located in the configuration
+tree.
.. code-block:: none
@@ -246,10 +262,17 @@ The ``[edit]`` text displays where the user is located in the configuration tree
Exit
^^^^
-The ``exit`` command exits the current configuration mode. If the current configuration level isn't the top-most, then the configuration level is put back to the top-most level.
-If the configuration level is at the top-most level, then it exits the configuration mode and returns to operational mode.
-The ``exit`` command cannot be used if uncommitted changes exists in the configuration file. To exit with uncommitted changes, you either need to use the ``exit discard`` command or you need to commit the changes before exiting.
-The ``exit`` command doesn't save the configuration, only the ``save`` command does. A warning will be given when exiting with unsaved changes. Using the ``exit`` command in operational mode will logout the session.
+The ``exit`` command exits the current configuration mode. If the current
+configuration level isn't the top-most, then the configuration level is put
+back to the top-most level.
+If the configuration level is at the top-most level, then it exits the
+configuration mode and returns to operational mode.
+The ``exit`` command cannot be used if uncommitted changes exists in the
+configuration file. To exit with uncommitted changes, you either need to use
+the ``exit discard`` command or you need to commit the changes before exiting.
+The ``exit`` command doesn't save the configuration, only the ``save`` command
+does. A warning will be given when exiting with unsaved changes. Using the
+``exit`` command in operational mode will logout the session.
Exiting from a configuration level:
@@ -302,7 +325,8 @@ Warning message when exiting with unsaved changes:
Load
^^^^
-The ``load`` command load a configuration from a local or remote file. You have to be use ``commit`` to make the change active
+The ``load`` command loads a configuration from a local or remote file. You have
+to use ``commit`` to make the changes active
.. code-block:: none
@@ -344,9 +368,11 @@ Copies the content of a public key to the ~/.ssh/authorized_keys file.
Merge
^^^^^
-The ``merge`` command merge the config from a local or remote file with the running config.
+The ``merge`` command merges the config from a local or remote file with the
+running config.
-In the example below exist a ``default-firewall.config`` file with some common firewall rules you saved earlier.
+In the below example exists a ``default-firewall.config`` file with some common
+firewall rules you saved earlier.
.. code-block:: none
@@ -390,7 +416,7 @@ Rename
The ``rename`` command allows you to rename or move a configuration object.
-See here how to move the configuration entrys from vlanid 3 to 2
+See here how to move the configuration entries from vlanid 3 to 2
.. code-block:: none
@@ -424,7 +450,8 @@ See here how to move the configuration entrys from vlanid 3 to 2
Rollback
^^^^^^^^
-You can ``rollback`` configuration using the rollback command, however this command will currently trigger a system reboot.
+You can ``rollback`` configuration using the rollback command, however this
+command will currently trigger a system reboot.
Use the compare command to verify the configuration you want to rollback to.
.. code-block:: none
@@ -445,7 +472,8 @@ Use the compare command to verify the configuration you want to rollback to.
Run
^^^
-The ``run`` command allows you to execute any operational mode commands without exiting the configuration session.
+The ``run`` command allows you to execute any operational mode commands without
+exiting the configuration session.
.. code-block:: none
@@ -460,7 +488,9 @@ The ``run`` command allows you to execute any operational mode commands without
Save
^^^^
-The ``save`` command saves the current configuration to non-volatile storage. VyOS also supports saving and loading configuration remotely using SCP, FTP, or TFTP.
+The ``save`` command saves the current configuration to non-volatile storage.
+VyOS also supports saving and loading configuration remotely using SCP, FTP, or
+TFTP.
.. code-block:: none
@@ -474,7 +504,7 @@ The ``save`` command saves the current configuration to non-volatile storage. Vy
Set
^^^
-The ``set`` command create all configuration entrys
+The ``set`` command creates all configuration entries
.. code-block:: none
@@ -484,9 +514,11 @@ The ``set`` command create all configuration entrys
Show
^^^^
-The ``show`` command in the configuration mode displays the configuration and show uncommitted changes.
+The ``show`` command in the configuration mode displays the configuration and
+show uncommitted changes.
-Show the hole config, the address and description of eth1 is moving to vlan 2 if you commit the changes.
+Shows the whole config, the address and description of eth1 is moving to vlan 2
+if you commit the changes.
.. code-block:: none
@@ -521,4 +553,4 @@ Show the hole config, the address and description of eth1 is moving to vlan 2 if
service {
ssh {
port 22
- ...... \ No newline at end of file
+ ......
diff --git a/docs/configuration/interfaces/openvpn.rst b/docs/configuration/interfaces/openvpn.rst
index b2559c95..d4ef47b0 100644
--- a/docs/configuration/interfaces/openvpn.rst
+++ b/docs/configuration/interfaces/openvpn.rst
@@ -1,3 +1,5 @@
+:lastproofread: 2021-07-30
+
.. _openvpn:
#######
@@ -43,7 +45,7 @@ Site-to-site mode supports x.509 but doesn't require it and can also work with
static keys, which is simpler in many cases. In this example, we'll configure
a simple site-to-site OpenVPN tunnel using a 2048-bit pre-shared key.
-First, one one of the systems generate the key using the operational command
+First, one of the system generates the key using the operational command
``generate openvpn key <filename>``. This will generate a key with the name
provided in the `/config/auth/` directory. Once generated, you will need to
copy this key to the remote router.
@@ -94,7 +96,7 @@ Remote Configuration:
set interfaces openvpn vtun1 local-address '10.255.1.2'
set interfaces openvpn vtun1 remote-address '10.255.1.1'
-The configurations above will default to using 128-bit Blowfish in CBC mode
+The above configurations will by default use 128-bit Blowfish in CBC mode
for encryption and SHA-1 for HMAC authentication. These are both considered
weak, but a number of other encryption and hashing algorithms are available:
@@ -177,7 +179,11 @@ First we need to specify the basic settings. 1194/UDP is the default. The
closing on connection resets or daemon reloads.
-.. note:: Using **openvpn-option -reneg-sec** can be tricky. This option is used to renegotiate data channel after n seconds. When used at both server and client, the lower value will trigger the renegotiation. If you set it to 0 on one side of the connection (to disable it), the chosen value on the other side will determine when the renegotiation will occur.
+.. note:: Using **openvpn-option -reneg-sec** can be tricky. This option is
+ used to renegotiate data channel after n seconds. When used at both server
+ and client, the lower value will trigger the renegotiation. If you set it
+ to 0 on one side of the connection (to disable it), the chosen value on the
+ other side will determine when the renegotiation will occur.
.. code-block:: none
@@ -200,7 +206,7 @@ you keep the files in `/config/auth/openvpn`
Now we need to specify the server network settings. In all cases we need to
specify the subnet for client tunnel endpoints. Since we want clients to access
-a specific network behind out router, we will use a push-route option for
+a specific network behind our router, we will use a push-route option for
installing that route on clients.
.. code-block:: none
@@ -236,12 +242,13 @@ OpenLDAP
--------
Enterprise installations usually ship a kind of directory service which is used
-to have a single password store for all employees. VyOS and OpenVPN support using
-LDAP/AD as single user backend.
+to have a single password store for all employees. VyOS and OpenVPN support
+using LDAP/AD as single user backend.
Authentication is done by using the ``openvpn-auth-ldap.so`` plugin which is
-shipped with every VyOS installation. A dedicated configuration file is required.
-It is best practise to store it in ``/config`` to survive image updates
+shipped with every VyOS installation. A dedicated configuration file is
+required. It is best practise to store it in ``/config`` to survive image
+updates
.. code-block:: none
@@ -327,7 +334,10 @@ If you only want to check if the user account is enabled and can authenticate
RequireGroup false
</Authorization>
-A complete LDAP auth OpenVPN configuration could look like the following example:
+A complete LDAP auth OpenVPN configuration could look like the following
+example:
+
+.. stop_vyoslinter
.. code-block:: none
@@ -357,10 +367,13 @@ A complete LDAP auth OpenVPN configuration could look like the following example
}
}
+.. start_vyoslinter
+
OpenVPN Client
##############
-VyOS can not only act as an OpenVPN site-to-site or Server for multiple clients.
+VyOS can not only act as an OpenVPN site-to-site but also as a Server for
+multiple clients.
You can indeed also configure any VyOS OpenVPN interface as an OpenVPN client
connecting to a VyOS OpenVPN server or any other OpenVPN server.
@@ -463,6 +476,6 @@ The following commands let you reset OpenVPN.
.. opcmd:: reset openvpn interface <interface>
- Uset this command to reset the OpenVPN process on a specific interface.
+ Use this command to reset the OpenVPN process on a specific interface.
diff --git a/docs/installation/migrate-from-vyatta.rst b/docs/installation/migrate-from-vyatta.rst
index eba9dc59..82bf2662 100644
--- a/docs/installation/migrate-from-vyatta.rst
+++ b/docs/installation/migrate-from-vyatta.rst
@@ -156,9 +156,9 @@ release.
Upon reboot, you should have a working installation of VyOS.
You can go back to your Vyatta install using the ``set system image
-default-boot`` command and selecting the your previous Vyatta Core image.
+default-boot`` command and selecting your previous Vyatta Core image.
.. note:: Future releases of VyOS will break the direct upgrade path from
Vyatta core. Please upgrade through an intermediate VyOS version e.g. VyOS
- 1.2. After this you can continue upgrading to newer releases once you bootet
+ 1.2. After this you can continue upgrading to newer releases once you booted
into VyOS 1.2 once.