diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/install.rst | 70 | ||||
| -rw-r--r-- | docs/interfaces/pppoe.rst | 2 | ||||
| -rw-r--r-- | docs/interfaces/wirelessmodem.rst | 4 | ||||
| -rw-r--r-- | docs/quick-start.rst | 52 | 
4 files changed, 79 insertions, 49 deletions
| diff --git a/docs/install.rst b/docs/install.rst index a210c1ad..11d0fc88 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -351,7 +351,7 @@ installation method which allows deploying VyOS through the network.  * :ref:`tftp-server`  * Webserver (HTTP) - optional, but we will use it to speed up installation  * VyOS ISO image to be installed (do not use images prior to VyOS 1.2.3) -* Files ``pxelinux.0`` and ``ldlinux.c32`` `from the Syslinux distribution <https://kernel.org/pub/linux/utils/boot/syslinux/>`_ +* Files *pxelinux.0* and *ldlinux.c32* `from the Syslinux distribution <https://kernel.org/pub/linux/utils/boot/syslinux/>`_  Configuration  ------------- @@ -363,7 +363,7 @@ Configure a DHCP server to provide the client with:  * An IP address  * The TFTP server address (DHCP option 66). Sometimes referred as *boot server* -* The *bootfile name* (DHCP option 67), which is ``pxelinux.0`` +* The *bootfile name* (DHCP option 67), which is *pxelinux.0*  In this example we configured an existent VyOS as the DHCP server: @@ -389,17 +389,18 @@ Step 2: TFTP  Configure a TFTP server so that it serves the following: -* The ``pxelinux.0`` file from the Syslinux distribution -* The ``ldlinux.c32`` file from the Syslinux distribution -* The kernel of the VyOS software you want to deploy. That is the ``vmlinuz`` -  file inside the ``/live`` directory of the extracted contents from the ISO -  file +* The *pxelinux.0* file from the Syslinux distribution +* The *ldlinux.c32* file from the Syslinux distribution +* The kernel of the VyOS software you want to deploy. That is the +  *vmlinuz* file inside the */live* directory of the extracted +  contents from the ISO file.  * The initial ramdisk of the VyOS ISO you want to deploy. That is the -  ``initrd.img`` file inside the ``/live`` directory of the extracted contents -  from the ISO file. Do not use an empty (0 bytes) initrd.img file you might -  find, the correct file may have a longer name. -* A directory named pxelinux.cfg which must contain the configuration file. -  We will use the configuration_ file shown below, which we named default_. +  *initrd.img* file inside the */live* directory of the extracted +  contents from the ISO file. Do not use an empty (0 bytes) initrd.img +  file you might find, the correct file may have a longer name. +* A directory named pxelinux.cfg which must contain the configuration +  file. We will use the configuration_ file shown below, which we named +  default_.  .. _configuration: https://wiki.syslinux.org/wiki/index.php?title=Config  .. _default: https://wiki.syslinux.org/wiki/index.php?title=PXELINUX#Configuration @@ -446,35 +447,44 @@ Example of simple (no menu) configuration file:  Step 3: HTTP  ^^^^^^^^^^^^ -As you can read in the configuration file, we are sending ``filesystem.squashfs`` -through HTTP. As that is a heavy file, we choose HTTP to speed up the transfer -over TFTP. +We also need to provide the *filesystem.squashfs* file. That is a heavy +file and TFTP is slow, so you could send it through HTTP to speed up the +transfer. That is how it is done in our example, you can find that in +the configuration file above. -First run a web server - you can use a simple one like -`Python's SimpleHTTPServer`_ and start serving the ``filesystem.squashfs`` -file. The file can be found inside the ``/live`` directory of the extracted -contents of the ISO file. +**First** run a web server - you can use a simple one like +`Python's SimpleHTTPServer`_ and start serving the `filesystem.squashfs` +file. The file can be found inside the `/live` directory of the +extracted contents of the ISO file. -Second, edit the configuration file of the :ref:`install_from_tftp` so that it shows -the correct URL at ``fetch=http://<address_of_your_HTTP_server>/filesystem.squashfs``. +**Second**, edit the configuration file of the :ref:`install_from_tftp` +so that it shows the correct URL at +``fetch=http://<address_of_your_HTTP_server>/filesystem.squashfs``. -And third, restart the TFTP service. If you are using VyOS as your TFTP Server, you can restart -the service with ``sudo service tftpd-hpa restart``. +.. note:: Do not change the name of the *filesystem.squashfs* file. If  +   you are working with different versions, you can create different +   directories instead. -.. note::  Make sure the available directories and files in both TFTP and HTTP -   server have the right permissions to be accessed from the booting clients. +And **third**, restart the TFTP service. If you are using VyOS as your +TFTP Server, you can restart the service with +``sudo service tftpd-hpa restart``. + +.. note::  Make sure the available directories and files in both TFTP +   and HTTP server have the right permissions to be accessed from the +   booting clients.  .. _`Python's SimpleHTTPServer`: https://docs.python.org/2/library/simplehttpserver.html  Client Boot  ----------- -Finally, turn on your PXE-enabled client or clients. They will automatically get an IP -address from the DHCP server and start booting into VyOS live from the files -automatically taken from the TFTP and HTTP servers. +Finally, turn on your PXE-enabled client or clients. They will +automatically get an IP address from the DHCP server and start booting +into VyOS live from the files automatically taken from the TFTP and HTTP +servers. -Once finished you will be able to proceed with the ``install image`` command as -in a regular VyOS installation. +Once finished you will be able to proceed with the ``install image`` +command as in a regular VyOS installation. diff --git a/docs/interfaces/pppoe.rst b/docs/interfaces/pppoe.rst index ae6b11cc..75fe0a40 100644 --- a/docs/interfaces/pppoe.rst +++ b/docs/interfaces/pppoe.rst @@ -79,7 +79,7 @@ Configuration  .. cfgcmd:: set interfaces pppoe <interface> connect-on-demand -   Enables or disables on-demand PPPoE connection on a PPPoE unit. +   When set the interface is enabled for "dial-on-demand".     Use this command to instruct the system to establish a PPPoE connections     automatically once traffic passes through the interface. A disabled on-demand diff --git a/docs/interfaces/wirelessmodem.rst b/docs/interfaces/wirelessmodem.rst index 5cded6c5..c41e71bf 100644 --- a/docs/interfaces/wirelessmodem.rst +++ b/docs/interfaces/wirelessmodem.rst @@ -35,9 +35,9 @@ Address     Do not install DNS nameservers received from ISP into system wide nameserver     list. -.. cfgcmd:: set interfaces wirelessmodem <interface> ondemand +.. cfgcmd:: set interfaces wirelessmodem <interface> connect-on-demand -   Enables or disables on-demand WWAN connection. +   When set the interface is enabled for "dial-on-demand".     Use this command to instruct the system to establish a PPP connection     automatically once traffic passes through the interface. A disabled on-demand diff --git a/docs/quick-start.rst b/docs/quick-start.rst index 19ee9f6e..550bfd77 100644 --- a/docs/quick-start.rst +++ b/docs/quick-start.rst @@ -4,7 +4,7 @@  Quick Start  ########### -This chapter will guide you on how to get up to speed using your new VyOS +This chapter will guide you on how to get up to speed quickly using your new VyOS  system. It will show you a very basic configuration example that will provide  a :ref:`nat` gateway for a device with two network interfaces (`eth0` and  `eth1`). @@ -14,6 +14,10 @@ a :ref:`nat` gateway for a device with two network interfaces (`eth0` and  Configuration Mode  ################## +By default, VyOS is in operational mode, and the command prompt displays a `$`. To configure VyOS, +you will need to enter configuration mode, resulting in the command prompt displaying a `#`, as +demonstrated below: +  .. code-block:: none    vyos@vyos$ configure @@ -22,13 +26,13 @@ Configuration Mode  Commit and Save  ################ -After every configuration change you need to apply the changes by using the +After every configuration change, you need to apply the changes by using the following command:  .. code-block:: none    commit -Once your configuration works as expected you can save it permanently. +Once your configuration works as expected, you can save it permanently by using the following command:  .. code-block:: none @@ -37,9 +41,9 @@ Once your configuration works as expected you can save it permanently.  Interface Configuration  ####################### -* Your outside/WAN interface will be `eth0`, it receives it's interface address -  be means of DHCP. -* Your internal/LAN interface is `eth1`. It uses a fixed IP address of +* Your outside/WAN interface will be `eth0`. It will receive its interface address +  via DHCP. +* Your internal/LAN interface will be `eth1`. It will use a static IP address of    `192.168.0.1/24`.  After switching to :ref:`quick-start-configuration-mode` issue the following @@ -69,14 +73,17 @@ on specific addresses only.  Configure DHCP/DNS Servers  ########################## -* Provide DHCP service on your internal/LAN network where VyOS will act -  as the default gateway and DNS server. -* Client IP addresses are assigned from the range ``192.168.0.9 - -  192.168.0.254`` +The following settings will configure DHCP and DNS services on your internal/LAN network, +where VyOS will act as the default gateway and DNS server. + +* The default gateway and DNS recursor address will be `192.168.0.1/24` +* The address range `192.168.0.2/24 - 192.168.0.8/24` will be reserved for static assignments +* DHCP clients will be assigned IP addresses within the range of `192.168.0.9 - 192.168.0.254` +  and have a domain name of `internal-network`  * DHCP leases will hold for one day (86400 seconds) -* VyOS will server as full DNS recursor - no need to bother the Google or -  Cloudflare DNS servers (good for privacy) -* Only clients from your internal/LAN network can use the DNS resolver +* VyOS will serve as a full DNS recursor, replacing the need to utilize Google,  +  Cloudflare, or other public DNS servers (which is good for privacy) +* Only hosts from your internal/LAN network can use the DNS recursor  .. code-block:: none @@ -95,7 +102,8 @@ Configure DHCP/DNS Servers  NAT  ### -* Configure :ref:`source-nat` for our internal/LAN network +The following settings will configure :ref:`source-nat` rules for our internal/LAN network, allowing +hosts to communicate through the outside/WAN network via IP masquerade.  .. code-block:: none @@ -188,11 +196,23 @@ Set up :ref:`ssh_key_based_authentication`:  Finally, try and SSH into the VyOS install as your new user. Once you have  confirmed that your new user can access your router without a password, delete -the original ``vyos`` user and probably disable password authentication for -:ref:`ssh` at all: +the original ``vyos`` user and completely disable password authentication for +:ref:`ssh`:  .. code-block:: none    delete system login user vyos    set service ssh disable-password-authentication +As above, commit your changes, save the configuration, and exit configuration mode: + +.. code-block:: none + +  vyos@vyos# commit +  vyos@vyos# save +  Saving configuration to '/config/config.boot'... +  Done +  vyos@vyos# exit +  vyos@vyos$ +  +You now should have a simple yet secure and functioning router to experiment with further. Enjoy! | 
