Merge pull request #366 from currite/crux-boot-options

system: add boot options (from old wiki)

4 files changed, 59 insertions, 0 deletions

diff --git a/docs/_static/images/boot-options.png b/docs/_static/images/boot-options.png
new file mode 100644
index 00000000..b00350bc
--- /dev/null
+++ b/docs/_static/images/boot-options.png
diff --git a/docs/appendix/troubleshooting.rst b/docs/appendix/troubleshooting.rst
index 27cb0d01..1da5c30e 100644
--- a/docs/appendix/troubleshooting.rst
+++ b/docs/appendix/troubleshooting.rst
@@ -301,6 +301,8 @@ to clear counters on firewall rulesets or single rules
 Basic System Information
 ------------------------
 
+.. _boot-steps:
+
 Boot steps
 ^^^^^^^^^^
 
diff --git a/docs/system/boot-options.rst b/docs/system/boot-options.rst
new file mode 100644
index 00000000..1070afa9
--- /dev/null
+++ b/docs/system/boot-options.rst
@@ -0,0 +1,56 @@
+.. _boot-options:
+
+
+############
+Boot Options
+############
+
+.. warning:: This function may be highly disruptive.
+   It may cause major service interruption, so make sure you really
+   need it and verify your input carefully.
+
+
+
+VyOS has several kernel command line options to modify the normal boot
+process. 
+To add an option, select the desired image in GRUB menu at load
+time, press **e**, edit the first line, and press **Ctrl-x** to boot when
+ready.
+
+.. image:: /_static/images/boot-options.png
+   :width: 80%
+   :align: center
+
+
+Specify custom config file
+==========================
+
+Tells the system to use specified file instead of ``/config/config.boot``.
+If specified file does not exist or is not readable, fall back to
+default config. No additional verification is performed, so make sure
+you specify a valid config file.
+
+.. code-block:: none
+
+   vyos-config=/path/to/file
+
+To load the *factory default* config, use:
+
+.. code-block:: none
+
+   vyos-config=/opt/vyatta/etc/config.boot.default
+
+
+Disable specific boot process steps
+===================================
+
+These options disable some boot steps. Make sure you understand the
+:ref:`boot process <boot-steps>` well before using them!
+
+.. glossary::
+
+    no-vyos-migrate
+      Do not perform config migration.
+
+    no-vyos-firewall
+      Do not initialize default firewall chains, renders any firewall configuration unusable.
diff --git a/docs/system/index.rst b/docs/system/index.rst
index 4edfce48..0a51e23c 100644
--- a/docs/system/index.rst
+++ b/docs/system/index.rst
@@ -22,3 +22,4 @@ should be ready for further configuration which is described in this chapter.
    syslog
    task-scheduler
    time-zone
+   boot-options