summaryrefslogtreecommitdiff
path: root/docs/configuration-overview.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration-overview.rst')
-rw-r--r--docs/configuration-overview.rst20
1 files changed, 12 insertions, 8 deletions
diff --git a/docs/configuration-overview.rst b/docs/configuration-overview.rst
index aba9b1dc..5118a4e7 100644
--- a/docs/configuration-overview.rst
+++ b/docs/configuration-overview.rst
@@ -1,8 +1,12 @@
.. _configuration-overview:
-######################
+######
+Basics
+######
+
+**********************
Configuration Overview
-######################
+**********************
VyOS makes use of a unified configuration file for all system configuration:
`config.boot`. This allows for easy template creation, backup, and replication
@@ -195,7 +199,7 @@ replacements and ``-`` for deletions.
vyos@vyos#
It is also possible to display all `set` commands within configuration mode
-using ``show | commands`
+using ``show | commands``
.. code-block:: sh
@@ -340,7 +344,7 @@ Archive
VyOS automatically maintains backups of previous configurations.
Local archive and revisions
-^^^^^^^^^^^^^^^^^^^^^^^^^^^
+---------------------------
Revisions are stored on disk. You can view them, compare them, and rollback to
previous revisions if anything goes wrong.
@@ -387,7 +391,7 @@ command:
vyos@vyos#
Comparing Revisions
-"""""""""""""""""""
+^^^^^^^^^^^^^^^^^^^
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
@@ -411,7 +415,7 @@ x misses when compared to y.
-}
Rolling Back Changes
-""""""""""""""""""""
+^^^^^^^^^^^^^^^^^^^^
You can rollback configuration using the rollback command. This command will
apply the selected revision and trigger a system reboot.
@@ -430,7 +434,7 @@ apply the selected revision and trigger a system reboot.
vyos@vyos#
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.
@@ -447,7 +451,7 @@ You can specify the location with:
* ``set system config-management commit-archive location URL``
-For example, ``set system config-management commit-archive location tftp://10.0.0.1/vyos`.
+For example, ``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