From 486c35233d0969d1d898c8da783d43999be560d4 Mon Sep 17 00:00:00 2001
From: currite <sll@disroot.org>
Date: Wed, 4 Nov 2020 21:16:38 +0100
Subject: advanced-system: boot options (migrated from old wiki)

The following options have not been migrated because we
did not find its valid and correct use:

no-vyos-configure
    Do not load the config, leaves you with plain Linux system.

no-vyos-rl-system
    Disables getting the system into clean state before loading the config.
---
 docs/_static/images/boot-options.png | Bin 0 -> 30582 bytes
 docs/system/advanced-index.rst       |   1 +
 docs/system/boot-options.rst         |  57 +++++++++++++++++++++++++++++++++++
 docs/troubleshooting.rst             |   2 ++
 4 files changed, 60 insertions(+)
 create mode 100644 docs/_static/images/boot-options.png
 create mode 100644 docs/system/boot-options.rst

(limited to 'docs')

diff --git a/docs/_static/images/boot-options.png b/docs/_static/images/boot-options.png
new file mode 100644
index 00000000..b00350bc
Binary files /dev/null and b/docs/_static/images/boot-options.png differ
diff --git a/docs/system/advanced-index.rst b/docs/system/advanced-index.rst
index 36469763..4e9c5699 100644
--- a/docs/system/advanced-index.rst
+++ b/docs/system/advanced-index.rst
@@ -11,6 +11,7 @@ Advanced System Tweaks
    flow-accounting
    ntp
    options
+   boot-options
    proxy
    serial-console
    syslog
diff --git a/docs/system/boot-options.rst b/docs/system/boot-options.rst
new file mode 100644
index 00000000..d054748f
--- /dev/null
+++ b/docs/system/boot-options.rst
@@ -0,0 +1,57 @@
+.. _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/troubleshooting.rst b/docs/troubleshooting.rst
index 23248507..2d6532d0 100644
--- a/docs/troubleshooting.rst
+++ b/docs/troubleshooting.rst
@@ -362,6 +362,8 @@ to clear counters on firewall rulesets or single rules
 System Information
 ******************
 
+.. _boot-steps:
+
 Boot Steps
 ==========
 
-- 
cgit v1.2.3