From b1cb71c71935ad6b0a7d9effe8f4dc4467de2175 Mon Sep 17 00:00:00 2001 From: rebortg Date: Mon, 30 Nov 2020 21:15:16 +0100 Subject: arrange: system configration --- docs/operation/boot-options.rst | 57 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 docs/operation/boot-options.rst (limited to 'docs/operation/boot-options.rst') diff --git a/docs/operation/boot-options.rst b/docs/operation/boot-options.rst new file mode 100644 index 00000000..d054748f --- /dev/null +++ b/docs/operation/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 ` 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. + -- cgit v1.2.3 From 4fd8e9cdf9418023e386fb0e5db2026cd2aca951 Mon Sep 17 00:00:00 2001 From: rebortg Date: Fri, 11 Dec 2020 14:32:09 +0100 Subject: operation: fix linter errors --- docs/operation/boot-options.rst | 3 ++- docs/operation/information.rst | 23 +++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) (limited to 'docs/operation/boot-options.rst') diff --git a/docs/operation/boot-options.rst b/docs/operation/boot-options.rst index d054748f..70cdc418 100644 --- a/docs/operation/boot-options.rst +++ b/docs/operation/boot-options.rst @@ -53,5 +53,6 @@ These options disable some boot steps. Make sure you understand the Do not perform config migration. no-vyos-firewall - Do not initialize default firewall chains, renders any firewall configuration unusable. + Do not initialize default firewall chains, renders any firewall + configuration unusable. diff --git a/docs/operation/information.rst b/docs/operation/information.rst index 02d6f1ec..ec2506cb 100644 --- a/docs/operation/information.rst +++ b/docs/operation/information.rst @@ -19,15 +19,15 @@ USB In the past serial interface have been defined as ttySx and ttyUSBx where x was an instance number of the serial interface. It was discovered that from system boot to system boot the mapping of USB based serial interfaces will differ, -depending which driver was loaded first by the operating system. This will become -rather painful if you not only have serial interfaces for a console server -connected but in addition also a serial backed :ref:`wwan-interface`. +depending which driver was loaded first by the operating system. This will +become rather painful if you not only have serial interfaces for a console +server connected but in addition also a serial backed :ref:`wwan-interface`. -To overcome this issue and the fact that in almost 50% of all cheap USB to serial -converters there is no serial number programmed, the USB to serial interface is -now directly identified by the USB root bridge and bus it connects to. This -somehow mimics the new network interface definitions we see in recend Linux -distributions. +To overcome this issue and the fact that in almost 50% of all cheap USB to +serial converters there is no serial number programmed, the USB to serial +interface is now directly identified by the USB root bridge and bus it connects +to. This somehow mimics the new network interface definitions we see in recend +Linux distributions. For additional details you can refer to https://phabricator.vyos.net/T2490. @@ -69,9 +69,9 @@ For additional details you can refer to https://phabricator.vyos.net/T2490. .. opcmd:: show hardware usb serial - Retrieve a list and description of all connected USB serial devices. The device name - displayed, e.g. `usb0b2.4p1.0` can be directly used when accessing the serial console - as console-server device. + Retrieve a list and description of all connected USB serial devices. The + device name displayed, e.g. `usb0b2.4p1.0` can be directly used when accessing + the serial console as console-server device. .. code-block:: none @@ -94,4 +94,3 @@ For additional details you can refer to https://phabricator.vyos.net/T2490. usb0b2.4p1.1 Quad_RS232-HS Future Technology Devices International, Ltd usb0b2.4p1.2 Quad_RS232-HS Future Technology Devices International, Ltd usb0b2.4p1.3 Quad_RS232-HS Future Technology Devices International, Ltd - -- cgit v1.2.3