Merge pull request #340 from currite/pxe-keep-squashfs-name

install: pxe: warn about keeping filesytem.squashfs name

1 files changed, 40 insertions, 30 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.