Added installation and CLI help from WiKi

2025-10-26 08:41:46 +01:00 · 2018-10-01 12:18:48 +02:00 · 2018-10-01 12:18:48 +02:00 · bfa27a8c47
commit bfa27a8c47
parent 68ca694227
3 changed files with 190 additions and 1 deletions
--- a/docs/ch01-install.rst
+++ b/docs/ch01-install.rst
@ -0,0 +1,97 @@
+Installation
+============
+
+The latest ISO image for VyOS can be downloaded at www.vyos.net.
+
+The recommended system requirements are 512MB RAM and 2GB storage.
+
+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``.
+
+.. code-block:: sh
+
+  The programs included with the Debian GNU/Linux system are free software;
+  the exact distribution terms for each program are described in the
+  individual files in /usr/share/doc/*/copyright.
+
+  Debian GNU/Linux comes with ABSOLUTELY NO WARRANTY, to the extent
+  permitted by applicable law.
+  vyos@vyos:~$
+
+  vyos@vyos:~$ uname -a
+  Linux vyos 4.18.8-amd64-vyos #22 SMP Wed Sep 19 18:24:39 CEST 2018 x86_64 GNU/Linux
+
+Unlike general purpose Linux distributions, VyOS uses "image installation"
+that mimics the user experience of traditional hardware routers and allows
+you to keep multiple VyOS versions on the same machine and switch to a previous
+version if something breaks after upgrade. Every version is contained in its
+own squashfs image that is mounted in a union filesystem together with a
+directory for mutable data (configs etc.).
+
+**Note:** older versions used to support non-image installation (`install
+system` command). It's been deprecated since the time image installation was
+introduced (long before the fork), and does not provide any version management
+capabilities. You **should not** use it for new installations even if it's still
+available in new versions. You should not worry about older systems installed
+that way though, they can be upgraded with "add system image".
+
+To install VyOS, run ``install image``.
+
+.. code-block:: sh
+
+  vyos@vyos:~$ install image
+  Welcome to the VyOS install program.  This script
+  will walk you through the process of installing the
+  VyOS image to a local hard drive.
+  Would you like to continue? (Yes/No) [Yes]: Yes
+  Probing drives: OK
+  Looking for pre-existing RAID groups...none found.
+  The VyOS image will require a minimum 2000MB root.
+  Would you like me to try to partition a drive automatically
+  or would you rather partition it manually with parted?  If
+  you have already setup your partitions, you may skip this step
+
+  Partition (Auto/Parted/Skip) [Auto]:
+
+  I found the following drives on your system:
+   sda    4294MB
+
+  Install the image on? [sda]:
+
+  This will destroy all data on /dev/sda.
+  Continue? (Yes/No) [No]: Yes
+
+  How big of a root partition should I create? (2000MB - 4294MB) [4294]MB:
+
+  Creating filesystem on /dev/sda1: OK
+  Done!
+  Mounting /dev/sda1...
+  What would you like to name this image? [1.2.0-rolling+201809210337]:
+  OK.  This image will be named: 1.2.0-rolling+201809210337
+  Copying squashfs image...
+  Copying kernel and initrd images...
+  Done!
+  I found the following configuration files:
+      /opt/vyatta/etc/config.boot.default
+  Which one should I copy to sda? [/opt/vyatta/etc/config.boot.default]:
+
+  Copying /opt/vyatta/etc/config.boot.default to sda.
+  Enter password for administrator account
+  Enter password for user 'vyos':
+  Retype password for user 'vyos':
+  I need to install the GRUB boot loader.
+  I found the following drives on your system:
+   sda    4294MB
+
+  Which drive should GRUB modify the boot partition on? [sda]:
+
+  Setting up grub: OK
+  Done!
+  vyos@vyos:~$
+
+After the installation is complete, remove the Live CD and reboot the system:
+
+.. code-block:: sh
+
+  vyos@vyos:~$ reboot
+  Proceed with reboot? (Yes/No) [No] Yes
--- a/docs/ch02-cli.rst
+++ b/docs/ch02-cli.rst
@ -0,0 +1,85 @@
+Command-Line Interface
+======================
+
+The VyOS CLI comprises an **operational mode** and a **configuration mode**.
+
+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.
+
+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
+commands and will present the help system upon a conflict or unknown value.
+
+For example typing `sh` followed by the **[tab]** key will complete to `show`.
+Pressing **[tab]** a second time will display the possible sub-commands of the
+`show` command.
+
+.. code-block:: sh
+
+  vyos@vyos:~$ s[tab]
+  set   show
+  vyos@vyos:~$
+
+Example showing possible show commands:
+
+.. code-block:: sh
+
+  vyos@vyos:~$ show [tab]
+  Possible completions:
+    arp           Show Address Resolution Protocol (ARP) information
+    bridge        Show bridging information
+    cluster       Show clustering information
+    configuration Show running configuration
+    conntrack     Show conntrack entries in the conntrack table
+    conntrack-sync
+                  Show connection syncing information
+    date          Show system date and time
+    dhcp          Show Dynamic Host Configuration Protocol (DHCP) information
+    dhcpv6        Show status related to DHCPv6
+    disk          Show status of disk device
+    dns           Show Domain Name Server (DNS) information
+    file          Show files for a particular image
+    firewall      Show firewall information
+    flow-accounting
+                  Show flow accounting statistics
+    hardware      Show system hardware details
+    history       show command history
+    host          Show host information
+    incoming      Show ethernet input-policy information
+  : q
+  vyos@vyos:~$
+
+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.
+
+When viewing in page mode the following commands are available:
+ * **[q]** key can be used to cancel output
+ * **[space]** will scroll down one page
+ * **[b]** will scroll back one page
+ * **[return]** will scroll down one line
+ * **[up-arrow]** and **[down-arrow]** will scroll up or down one line at a
+   time respectively
+ * **[left-arrow]** and **[right-arrow]** can be used to scroll left or right
+   in the event that the output has lines which exceed the terminal size.
+
+To enter configuration mode use the `configure` command:
+
+.. code-block:: sh
+
+  vyos@vyos:~$ configure
+  [edit]
+  vyos@vyos:~#
+
+Note that the prompt changes from `$` to `#`. To exit configuration mode, type
+`exit`.
+
+.. code-block:: sh
+
+  vyos@vyos:~# exit
+  exit
+  vyos@vyos:~$
+
+See the configuration section of this document for more information on
+configuration mode.
--- a/docs/index.rst
+++ b/docs/index.rst
@ -14,7 +14,14 @@ Introduction
 ============
 VyOS is an open source network operating system based on Debian GNU/Linux.

-VyOS provides a free routing platform that competes directly with other commercially available solutions from well known network providers. Because VyOS is run on standard amd64, i586 and ARM systems, it is able to be used as a router and firewall platform for cloud deployments.
+VyOS provides a free routing platform that competes directly with other
+commercially available solutions from well known network providers. Because
+VyOS is run on standard amd64, i586 and ARM systems, it is able to be used
+as a router and firewall platform for cloud deployments.
+
+.. include:: ch01-install.rst
+
+.. include:: ch02-cli.rst

 Indices and tables
 ==================