From f357e38054a5b25e86b2b3e43a16c639ed0a8340 Mon Sep 17 00:00:00 2001 From: currite Date: Sat, 27 Jul 2019 02:31:39 +0200 Subject: improve install doc and try my first commit :) --- docs/install.rst | 214 ++++++++++++++++++++++++++++++++----------------------- 1 file changed, 123 insertions(+), 91 deletions(-) (limited to 'docs') diff --git a/docs/install.rst b/docs/install.rst index 7dc5a065..4aeb40b6 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -1,12 +1,132 @@ .. _installation: -Installation -============ +Getting the software +==================== + -The latest ISO image for VyOS can be downloaded at https://www.vyos.net. +Requirements +------------ The recommended system requirements are 512 MiB RAM and 2 GiB storage. + +Download +-------- + +The latest ISO image for VyOS can be downloaded from https://vyos.io/ + + +Verifying digital signatures +---------------------------- + +We sign our packages with our private key. So, if you have our public key, you will be able to verify the authenticity of the package. + +First you need to install GPG or another OpenPGP implementation. +On most GNU+Linux distributions it is installed by default because package managers use it to verify package signatures. +On other systems you may need to find and install the package. + +Then you need our public key. + +If you don't have it yet, you can get it from a key server. + +``gpg --recv-keys FD220285A0FE6D7E`` + +Or open your web browser, visit a key server and copy our public key from there: https://pgp.mit.edu/pks/lookup?op=get&search=0xFD220285A0FE6D7E + +Or from this block below. + + + +.. code-block:: sh + + -----BEGIN PGP PUBLIC KEY BLOCK----- + Version: GnuPG v1.4.12 (GNU/Linux) + + mQINBFXKsiIBEACyid9PR/v56pSRG8VgQyRwvzoI7rLErZ8BCQA2WFxA6+zNy+6G + +0E/6XAOzE+VHli+wtJpiVJwAh+wWuqzOmv9css2fdJxpMW87pJAS2i3EVVVf6ab + wU848JYLGzc9y7gZrnT1m2fNh4MXkZBNDp780WpOZx8roZq5X+j+Y5hk5KcLiBn/ + lh9Zoh8yzrWDSXQsz0BGoAbVnLUEWyo0tcRcHuC0eLx6oNG/IHvd/+kxWB1uULHU + SlB/6vcx56lLqgzywkmhP01050ZDyTqrFRIfrvw6gLQaWlgR3lB93txvF/sz87Il + VblV7e6HEyVUQxedDS8ikOyzdb5r9a6Zt/j8ZPSntFNM6OcKAI7U1nDD3FVOhlVn + 7lhUiNc+/qjC+pR9CrZjr/BTWE7Zpi6/kzeH4eAkfjyALj18oC5udJDjXE5daTL3 + k9difHf74VkZm29Cy9M3zPckOZpsGiBl8YQsf+RXSBMDVYRKZ1BNNLDofm4ZGijK + mriXcaY+VIeVB26J8m8y0zN4/ZdioJXRcy72c1KusRt8e/TsqtC9UFK05YpzRm5R + /nwxDFYb7EdY/vHUFOmfwXLaRvyZtRJ9LwvRUAqgRbbRZg3ET/tn6JZk8hqx3e1M + IxuskOB19t5vWyAo/TLGIFw44SErrq9jnpqgclTSRgFjcjHEm061r4vjoQARAQAB + tDZWeU9TIE1haW50YWluZXJzIChWeU9TIFJlbGVhc2UpIDxtYWludGFpbmVyc0B2 + eW9zLm5ldD6JAjgEEwECACIFAlXKsiICGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4B + AheAAAoJEP0iAoWg/m1+xbgP+QEDYZi5dA4IPY+vU1L95Bavju2m2o35TSUDPg5B + jfAGuhbsNUceU+l/yUlxjpKEmvshyW3GHR5QzUaKGup/ZDBo1CBxZNhpSlFida2E + KAYTx4vHk3MRXcntiAj/hIJwRtzCUp5UQIqHoU8dmHoHOkKEP+zhJuR6E2s+WwDr + nTwE6eRa0g/AHY+chj2Je6flpPm2CKoTfUE7a2yBBU3wPq3rGtsQgVxPAxHRZz7A + w4AjH3NM1Uo3etuiDnGkJAuoKKb1J4X3w2QlbwlR4cODLKhJXHIufwaGtRwEin9S + 1l2bL8V3gy2Hv3D2t9TQZuR5NUHsibJRXLSa8WnSCcc6Bij5aqfdpYB+YvKH/rIm + GvYPmLZDfKGkx0JE4/qtfFjiPJ5VE7BxNyliEw/rnQsxWAGPqLlL61SD8w5jGkw3 + CinwO3sccTVcPz9b6A1RsbBVhTJJX5lcPn1lkOEVwQ7l8bRhOKCMe0P53qEDcLCd + KcXNnAFbVes9u+kfUQ4oxS0G2JS9ISVNmune+uv+JR7KqSdOuRYlyXA9uTjgWz4y + Cs7RS+CpkJFqrqOtS1rmuDW9Ea4PA8ygGlisM5d/AlVkniHz/2JYtgetiLCj9mfE + MzQpgnldNSPumKqJ3wwmCNisE+lXQ5UXCaoaeqF/qX1ykybQn41LQ+0xT5Uvy7sL + 9IwGuQINBFXKsiIBEACg2mP3QYkXdgWTK5JyTGyttE6bDC9uqsK8dc1J66Tjd5Ly + Be0amO+88GHXa0o5Smwk2QNoxsRR41G/D/eAeGsuOEYnePROEr3tcLnDjo4KLgQ+ + H69zRPn77sdP3A34Jgp+QIzByJWM7Cnim31quQP3qal2QdpGJcT/jDJWdticN76a + Biaz+HN13LyvZM+DWhUDttbjAJc+TEwF9YzIrU+3AzkTRDWkRh4kNIQxjlpNzvho + 9V75riVqg2vtgPwttPEhOLb0oMzy4ADdfezrfVvvMb4M4kY9npu4MlSkNTM97F/I + QKy90JuSUIjE05AO+PDXJF4Fd5dcpmukLV/2nV0WM2LAERpJUuAgkZN6pNUFVISR + +nSfgR7wvqeDY9NigHrJqJbSEgaBUs6RTk5hait2wnNKLJajlu3aQ2/QfRT/kG3h + ClKUz3Ju7NCURmFE6mfsdsVrlIsEjHr/dPbXRswXgC9FLlXpWgAEDYi9Wdxxz8o9 + JDWrVYdKRGG+OpLFh8AP6QL3YnZF+p1oxGUQ5ugXauAJ9YS55pbzaUFP8oOO2P1Q + BeYnKRs1GcMI8KWtE/fze9C9gZ7Dqju7ZFEyllM4v3lzjhT8muMSAhw41J22mSx6 + VRkQVRIAvPDFES45IbB6EEGhDDg4pD2az8Q7i7Uc6/olEmpVONSOZEEPsQe/2wAR + AQABiQIfBBgBAgAJBQJVyrIiAhsMAAoJEP0iAoWg/m1+niUQAKTxwJ9PTAfB+XDk + 3qH3n+T49O2wP3fhBI0EGhJp9Xbx29G7qfEeqcQm69/qSq2/0HQOc+w/g8yy71jA + 6rPuozCraoN7Im09rQ2NqIhPK/1w5ZvgNVC0NtcMigX9MiSARePKygAHOPHtrhyO + rJQyu8E3cV3VRT4qhqIqXs8Ydc9vL3ZrJbhcHQuSLdZxM1k+DahCJgwWabDCUizm + sVP3epAP19FP8sNtHi0P1LC0kq6/0qJot+4iBiRwXMervCD5ExdOm2ugvSgghdYN + BikFHvmsCxbZAQjykQ6TMn+vkmcEz4fGAn4L7Nx4paKEtXaAFO8TJmFjOlGUthEm + CtHDKjCTh9WV4pwG2WnXuACjnJcs6LcK377EjWU25H4y1ff+NDIUg/DWfSS85iIc + UgkOlQO6HJy0O96L5uxn7VJpXNYFa20lpfTVZv7uu3BC3RW/FyOYsGtSiUKYq6cb + CMxGTfFxGeynwIlPRlH68BqH6ctR/mVdo+5UIWsChSnNd1GreIEI6p2nBk3mc7jZ + 7pTEHpjarwOjs/S/lK+vLW53CSFimmW4lw3MwqiyAkxl0tHAT7QMHH9Rgw2HF/g6 + XD76fpFdMT856dsuf+j2uuJFlFe5B1fERBzeU18MxML0VpDmGFEaxxypfACeI/iu + 8vzPzaWHhkOkU8/J/Ci7+vNtUOZb + =Ld8S + -----END PGP PUBLIC KEY BLOCK----- + + + +Then you can paste that text in a new file, and import the file into GPG: + +``gpg --import your_file_with_our_public_key`` + + +You can now check your GPG software has our public key. + +.. code-block:: sh + + $ gpg --list-keys + ... + pub rsa4096 2015-08-12 [SC] + 0694A9230F5139BF834BA458FD220285A0FE6D7E + uid [ unknown] VyOS Maintainers (VyOS Release) + sub rsa4096 2015-08-12 [E] + + +And finally verify signatures. The signature is that little .asc file you should download along with your chosen VyOS software. + +.. code-block:: sh + + $ gpg2 --verify vyos-1.2.1-amd64.iso.asc vyos-1.2.1-amd64.iso + gpg: Signature made So 14 Apr 12:58:07 2019 CEST + gpg: using RSA key FD220285A0FE6D7E + gpg: Good signature from "VyOS Maintainers (VyOS Release) " [unknown] + Primary key fingerprint: 0694 A923 0F51 39BF 834B A458 FD22 0285 A0FE 6D7E + + + +Installation +------------ + + The VyOS ISO is a Live CD and will boot to a functional VyOS image. To login to the system, use the default username ``vyos`` with password ``vyos``. @@ -102,92 +222,4 @@ After the installation is complete, remove the Live CD and reboot the system: Proceed with reboot? (Yes/No) [No] Yes -Verify digital signatures -------------------------- - -First you need to install GPG or another PGP implementation. -On most Linux distributions it's installed by default because package managers use it to verify package signatures. -On other systems you may need to find and install the package. - -You nee to import the key. - -``gpg --import maintainers.key`` - -| get the key from here: https://pgp.mit.edu/pks/lookup?op=vindex&search=0xFD220285A0FE6D7E -| or alternatively, you can import it by hand: - -.. code-block:: sh - - -----BEGIN PGP PUBLIC KEY BLOCK----- - Version: GnuPG v1.4.12 (GNU/Linux) - - mQINBFXKsiIBEACyid9PR/v56pSRG8VgQyRwvzoI7rLErZ8BCQA2WFxA6+zNy+6G - +0E/6XAOzE+VHli+wtJpiVJwAh+wWuqzOmv9css2fdJxpMW87pJAS2i3EVVVf6ab - wU848JYLGzc9y7gZrnT1m2fNh4MXkZBNDp780WpOZx8roZq5X+j+Y5hk5KcLiBn/ - lh9Zoh8yzrWDSXQsz0BGoAbVnLUEWyo0tcRcHuC0eLx6oNG/IHvd/+kxWB1uULHU - SlB/6vcx56lLqgzywkmhP01050ZDyTqrFRIfrvw6gLQaWlgR3lB93txvF/sz87Il - VblV7e6HEyVUQxedDS8ikOyzdb5r9a6Zt/j8ZPSntFNM6OcKAI7U1nDD3FVOhlVn - 7lhUiNc+/qjC+pR9CrZjr/BTWE7Zpi6/kzeH4eAkfjyALj18oC5udJDjXE5daTL3 - k9difHf74VkZm29Cy9M3zPckOZpsGiBl8YQsf+RXSBMDVYRKZ1BNNLDofm4ZGijK - mriXcaY+VIeVB26J8m8y0zN4/ZdioJXRcy72c1KusRt8e/TsqtC9UFK05YpzRm5R - /nwxDFYb7EdY/vHUFOmfwXLaRvyZtRJ9LwvRUAqgRbbRZg3ET/tn6JZk8hqx3e1M - IxuskOB19t5vWyAo/TLGIFw44SErrq9jnpqgclTSRgFjcjHEm061r4vjoQARAQAB - tDZWeU9TIE1haW50YWluZXJzIChWeU9TIFJlbGVhc2UpIDxtYWludGFpbmVyc0B2 - eW9zLm5ldD6JAjgEEwECACIFAlXKsiICGwMGCwkIBwMCBhUIAgkKCwQWAgMBAh4B - AheAAAoJEP0iAoWg/m1+xbgP+QEDYZi5dA4IPY+vU1L95Bavju2m2o35TSUDPg5B - jfAGuhbsNUceU+l/yUlxjpKEmvshyW3GHR5QzUaKGup/ZDBo1CBxZNhpSlFida2E - KAYTx4vHk3MRXcntiAj/hIJwRtzCUp5UQIqHoU8dmHoHOkKEP+zhJuR6E2s+WwDr - nTwE6eRa0g/AHY+chj2Je6flpPm2CKoTfUE7a2yBBU3wPq3rGtsQgVxPAxHRZz7A - w4AjH3NM1Uo3etuiDnGkJAuoKKb1J4X3w2QlbwlR4cODLKhJXHIufwaGtRwEin9S - 1l2bL8V3gy2Hv3D2t9TQZuR5NUHsibJRXLSa8WnSCcc6Bij5aqfdpYB+YvKH/rIm - GvYPmLZDfKGkx0JE4/qtfFjiPJ5VE7BxNyliEw/rnQsxWAGPqLlL61SD8w5jGkw3 - CinwO3sccTVcPz9b6A1RsbBVhTJJX5lcPn1lkOEVwQ7l8bRhOKCMe0P53qEDcLCd - KcXNnAFbVes9u+kfUQ4oxS0G2JS9ISVNmune+uv+JR7KqSdOuRYlyXA9uTjgWz4y - Cs7RS+CpkJFqrqOtS1rmuDW9Ea4PA8ygGlisM5d/AlVkniHz/2JYtgetiLCj9mfE - MzQpgnldNSPumKqJ3wwmCNisE+lXQ5UXCaoaeqF/qX1ykybQn41LQ+0xT5Uvy7sL - 9IwGuQINBFXKsiIBEACg2mP3QYkXdgWTK5JyTGyttE6bDC9uqsK8dc1J66Tjd5Ly - Be0amO+88GHXa0o5Smwk2QNoxsRR41G/D/eAeGsuOEYnePROEr3tcLnDjo4KLgQ+ - H69zRPn77sdP3A34Jgp+QIzByJWM7Cnim31quQP3qal2QdpGJcT/jDJWdticN76a - Biaz+HN13LyvZM+DWhUDttbjAJc+TEwF9YzIrU+3AzkTRDWkRh4kNIQxjlpNzvho - 9V75riVqg2vtgPwttPEhOLb0oMzy4ADdfezrfVvvMb4M4kY9npu4MlSkNTM97F/I - QKy90JuSUIjE05AO+PDXJF4Fd5dcpmukLV/2nV0WM2LAERpJUuAgkZN6pNUFVISR - +nSfgR7wvqeDY9NigHrJqJbSEgaBUs6RTk5hait2wnNKLJajlu3aQ2/QfRT/kG3h - ClKUz3Ju7NCURmFE6mfsdsVrlIsEjHr/dPbXRswXgC9FLlXpWgAEDYi9Wdxxz8o9 - JDWrVYdKRGG+OpLFh8AP6QL3YnZF+p1oxGUQ5ugXauAJ9YS55pbzaUFP8oOO2P1Q - BeYnKRs1GcMI8KWtE/fze9C9gZ7Dqju7ZFEyllM4v3lzjhT8muMSAhw41J22mSx6 - VRkQVRIAvPDFES45IbB6EEGhDDg4pD2az8Q7i7Uc6/olEmpVONSOZEEPsQe/2wAR - AQABiQIfBBgBAgAJBQJVyrIiAhsMAAoJEP0iAoWg/m1+niUQAKTxwJ9PTAfB+XDk - 3qH3n+T49O2wP3fhBI0EGhJp9Xbx29G7qfEeqcQm69/qSq2/0HQOc+w/g8yy71jA - 6rPuozCraoN7Im09rQ2NqIhPK/1w5ZvgNVC0NtcMigX9MiSARePKygAHOPHtrhyO - rJQyu8E3cV3VRT4qhqIqXs8Ydc9vL3ZrJbhcHQuSLdZxM1k+DahCJgwWabDCUizm - sVP3epAP19FP8sNtHi0P1LC0kq6/0qJot+4iBiRwXMervCD5ExdOm2ugvSgghdYN - BikFHvmsCxbZAQjykQ6TMn+vkmcEz4fGAn4L7Nx4paKEtXaAFO8TJmFjOlGUthEm - CtHDKjCTh9WV4pwG2WnXuACjnJcs6LcK377EjWU25H4y1ff+NDIUg/DWfSS85iIc - UgkOlQO6HJy0O96L5uxn7VJpXNYFa20lpfTVZv7uu3BC3RW/FyOYsGtSiUKYq6cb - CMxGTfFxGeynwIlPRlH68BqH6ctR/mVdo+5UIWsChSnNd1GreIEI6p2nBk3mc7jZ - 7pTEHpjarwOjs/S/lK+vLW53CSFimmW4lw3MwqiyAkxl0tHAT7QMHH9Rgw2HF/g6 - XD76fpFdMT856dsuf+j2uuJFlFe5B1fERBzeU18MxML0VpDmGFEaxxypfACeI/iu - 8vzPzaWHhkOkU8/J/Ci7+vNtUOZb - =Ld8S - -----END PGP PUBLIC KEY BLOCK----- - - - -.. code-block:: sh - - $ gpg --list-keys - ... - pub rsa4096 2015-08-12 [SC] - 0694A9230F5139BF834BA458FD220285A0FE6D7E - uid [ unknown] VyOS Maintainers (VyOS Release) - sub rsa4096 2015-08-12 [E] - -Now you can verify signatures: - -.. code-block:: sh - $ gpg2 --verify vyos-1.2.1-amd64.iso.asc vyos-1.2.1-amd64.iso - gpg: Signature made So 14 Apr 12:58:07 2019 CEST - gpg: using RSA key FD220285A0FE6D7E - gpg: Good signature from "VyOS Maintainers (VyOS Release) " [unknown] - Primary key fingerprint: 0694 A923 0F51 39BF 834B A458 FD22 0285 A0FE 6D7E -- cgit v1.2.3 From 9979bd55ce68e5cb2624d15f4b87f710804b2b69 Mon Sep 17 00:00:00 2001 From: currite Date: Sat, 27 Jul 2019 12:41:52 +0200 Subject: add a reference and document normal scrolling --- docs/cli.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs') diff --git a/docs/cli.rst b/docs/cli.rst index cf8706d5..c1306c82 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -7,8 +7,7 @@ The VyOS CLI comprises an :ref:`commandtree_operationmode` and a :ref:`commandt Operational mode allows for commands to perform operational system tasks and view system and service status, while configuration mode allows for the -modification of system configuration. The command tree page lists available -commands and their functions. +modification of system configuration. The :ref:`command tree page` lists available commands and their functions. The CLI provides a built-in help system. In the CLI the **[?]** key may be used to display available commands. The **[tab]** key can be used to auto-complete @@ -53,6 +52,8 @@ Example showing possible show commands: : q vyos@vyos:~$ +You can scroll up with the keys [Shift]+[PageUp] and sroll down with [Shift]+[PageDown]. + When the output of a command results in more lines than can be displayed on the terminal screen the output is paginated as indicated by a : prompt. -- cgit v1.2.3 From 6b369fff64b02e4134a6e22949ce7a3334598fed Mon Sep 17 00:00:00 2001 From: currite Date: Tue, 30 Jul 2019 12:14:56 +0200 Subject: fix typos, clarify some texts and add terminology from wiki --- docs/configuration-overview.rst | 86 ++++++++++++++++++++++++----------------- 1 file changed, 51 insertions(+), 35 deletions(-) (limited to 'docs') diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst index a66e7b8e..ba775489 100644 --- a/docs/configuration-overview.rst +++ b/docs/configuration-overview.rst @@ -7,7 +7,7 @@ VyOS makes use of a unified configuration file for all system configuration: `config.boot`. This allows for easy template creation, backup, and replication of system configuration. -The current configuration can be viewed using the show configuration command. +The current active configuration -aka running configuration- can be viewed using the show configuration command. .. code-block:: sh @@ -63,12 +63,11 @@ The current configuration can be viewed using the show configuration command. } vyos@vyos:~$ -By default the configuration is display'ed in a hierarchy like the example above, +By default the configuration is displayed in a hierarchy like the example above, this is only one of the possible ways to display the configuration. -When the configuration is generated and the device is configured, these changes are added -with a corresponding set of `set` and `delete` commands, as for this you could also display -the current configuration using these `set` commands using the `show configuration commands` command. +When the configuration is generated and the device is configured, changes are added through a collection of `set` and `delete` commands. You can see that collection of commands by entering `show configuration commands`, which is another way of seeing the running configuration. + .. code-block:: sh @@ -88,7 +87,26 @@ the current configuration using these `set` commands using the `show configurati set system syslog global facility protocols level 'debug' vyos@vyos:~$ -Both these commands are for beeing executed when in operational mode, these commands does not work within the configuration mode. +Both these commands should be executed when in operational mode, they do not work in configuration mode. + + +Configuration terminology +------------------------- + +A VyOS system has three major types of configurations: + +Active or running configuration +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +The active or running configuration is the system configuration that is loaded and currently being used by VyOS. Any change in the configuration will have to be committed to belong to the active/running configuration. + +Working configuration +^^^^^^^^^^^^^^^^^^^^^ +The working configuration is the configuration which is currently being modified in configuration mode. Changes made to the working configuration do not go into effect until the changes are committed with the `commit` command. At which time the working configuration will become the active or running configuration. + +Saved configuration +^^^^^^^^^^^^^^^^^^^ +A saved configuration is a configuration saved to a file using the `save` command. It allowes you to keep safe a configuration for future uses. There can be multiple configuration files. The default or "boot" configuration is saved and loaded from the file config.boot. + Navigating in Configuration Mode --------------------------------- @@ -101,10 +119,9 @@ to enter configuration mode enter the command `configure` when in operational mo [edit] cyos@vyos# -.. note:: Prompt changes from `$` to `#`. To exit configuration mode, type `exit`. +.. note:: When going into configuration mode, prompt changes from *$* to *#*. To exit configuration mode, type `exit`. -All commands executed here is relative to the configuration level you have entered, everything is possible to do from the top level -but commands will be quite lengthy when manually typing them. +All commands executed here are relative to the configuration level you have entered. You can do everything from the top level, but commands will be quite lengthy when manually typing them. To change the current hierarchy level use the command: `edit` @@ -118,13 +135,13 @@ To change the current hierarchy level use the command: `edit` You are now in a sublevel relative to `interfaces ethernet eth0`, all commands executed from this point on are relative to this sublevel. -to exit back to the top of the hierarchy use the `top` command or the `exit` command. -This brings you back to the top of the hierarchy. - +Use either the `top` or `exit` command to go back to the top of the hierarchy. + -The show command within configuration mode will show the current configuration +The `show` command within configuration mode will show the working configuration indicating line changes with a + for additions and a - for deletions. + .. code-block:: sh vyos@vyos:~$ configure @@ -150,15 +167,15 @@ indicating line changes with a + for additions and a - for deletions. [edit] vyos@vyos# -it is also possible to display all `set` commands within configuration mode using `show | commands` +It is also possible to display all `set` commands within configuration mode using `show | commands` .. code-block:: sh - vyos@vyos# show interfaces iethernet eth0 | commands + vyos@vyos# show interfaces ethernet eth0 | commands set address dhcp set hw-id 00:0c:29:44:3b:0f -these command is also relative to the level you are inside and only relevant configuration blocks will be displayed when entering a sub-level +These commands are also relative to the level you are inside and only relevant configuration blocks will be displayed when entering a sub-level. .. code-block:: sh @@ -167,7 +184,7 @@ these command is also relative to the level you are inside and only relevant con address dhcp hw-id 00:0c:29:44:3b:0f -exiting from the configuration mode is done via the `exit` command from the top level, executing `exit` from within a sub-level takes you back to the top level. +Exiting from the configuration mode is done via the `exit` command from the top level, executing `exit` from within a sub-level takes you back to the top level. .. code-block:: sh @@ -180,14 +197,13 @@ exiting from the configuration mode is done via the `exit` command from the top - Managing the configuration -------------------------- -The configuration is managed by the use of `set` and `delete` commands from within configuration mode -Configuration commands are flattend from the tree into 'one-liner' commands shown in `show configuration commands` from operation mode +The configuration is managed by the use of `set` and `delete` commands from within configuration mode. +Configuration commands are flattend from the tree into 'one-liner' commands shown in `show configuration commands` from operation mode. -these commands are also relative to the level where they are executed and all redundant information from the current level is removed from the command entered +These commands are also relative to the level where they are executed and all redundant information from the current level is removed from the command entered. .. code-block:: sh @@ -197,18 +213,17 @@ these commands are also relative to the level where they are executed and all re [edit interfaces ethernet eth0] vyos@vyos# set address 1.2.3.4/24 -These two commands are essential the same, just executed from different levels in the hierarchy +These two commands above are essentially the same, just executed from different levels in the hierarchy. To delete a configuration entry use the `delete` command, this also deletes all sub-levels under the current level you've specified in the `delete` command. -Deleting a entry could also mean to reset it back to its default value if the element is mandatory, in each case it will be removed from the configuration file +Deleting an entry could also mean to reset it back to its default value if the element is mandatory, in each case it will be removed from the configuration file. .. code-block:: sh [edit interfaces ethernet eth0] vyos@vyos# delete address 1.2.3.4/24 -Configuration changes made do not take effect until committed using the commit -command in configuration mode. +Any change you do on the configuration, will not take effect until committed using the `commit` command in configuration mode. .. code-block:: sh @@ -219,7 +234,7 @@ command in configuration mode. vyos@vyos:~$ In order to preserve configuration changes upon reboot, the configuration must -also be saved once applied. This is done using the save command in +also be saved once applied. This is done using the `save` command in configuration mode. .. code-block:: sh @@ -245,7 +260,7 @@ used. exit vyos@vyos:~$ -VyOS also maintains backups of previous configurations. To compare +VyOS automatically maintains backups of previous configurations. To compare configuration revisions in configuration mode, use the compare command: .. code-block:: sh @@ -310,8 +325,8 @@ Operational info from config mode When inside configuration mode you are not directly able to execute operational commands, access to these commands are possible trough the use of the `run [command]` command. -from this command you will have access to everything accessable from operational mode, -Command completeion and syntax help with `?` and `[tab]` wil also work. +From this command you will have access to everything accessible from operational mode. +Command completion and syntax help with `?` and `[tab]` will also work. .. code-block:: sh @@ -326,7 +341,7 @@ Command completeion and syntax help with `?` and `[tab]` wil also work. Configuration archive --------------------- -VyOS has built-in config archiving and versionin that renders tools like rancid largely unnecessary. +VyOS has built-in config archiving and versioning that renders tools like rancid, largely unnecessary. This feature was available in Vyatta Core since 6.3 @@ -334,7 +349,7 @@ Local archive and revisions ~~~~~~~~~~~~~~~~~~~~~~~~~~~ Revisions are stored on disk, you can view them, compare them, and rollback to previous revisions if anything goes wrong. -To view existing revisions, use "show system commit" operational mode command. +To view existing revisions, use `show system commit` operational mode command. .. code-block:: sh @@ -348,7 +363,7 @@ To view existing revisions, use "show system commit" operational mode command. 6 2015-03-25 00:16:47 by vyos via cli 7 2015-03-24 23:43:45 by root via boot-config-loader -You can compare revisions with "compare X Y" command where X and Y are revision numbers. +You can compare revisions with `compare X Y` command, where X and Y are revision numbers. The output will describe how the configuration X is when comparted to Y, indicating with a plus sign (**+**) the additional parts X has when compared to y, and indicating with a minus sign (**-**) the lacking parts x misses when compared to y. .. code-block:: sh @@ -365,14 +380,15 @@ You can compare revisions with "compare X Y" command where X and Y are revision - address 192.0.2.4/24 -} -You can rollback to a previous revision with "rollback X", where X is a revision number. Your system will reboot and load the config from the archive. + +You can rollback to a previous revision with `rollback X`, where X is a revision number. Your system will reboot and load the config from the archive. Configuring the archive size ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -You can specify the number of revisions stored on disk with "set system config-management commit-revisions X", where X is a number between 0 and 65535. When the number of revisions exceeds that number, the oldest revision is removed. +You can specify the number of revisions stored on disk with `set system config-management commit-revisions X`, where X is a number between 0 and 65535. When the number of revisions exceeds that number, the oldest revision is removed. Remote archive ~~~~~~~~~~~~~~ VyOS can copy the config to a remote location after each commit. TFTP, FTP, and SFTP servers are supported. -You can specify the location with "set system config-management commit-archive location URL" command, e.g. "set system config-management commit-archive location tftp://10.0.0.1/vyos". +You can specify the location with `set system config-management commit-archive location URL` command, e.g. `set system config-management commit-archive location tftp://10.0.0.1/vyos`. -- cgit v1.2.3