[pbs-devel] [PATCH proxmox-backup 1/3] docs: add installation media preparation guide

[Christoph Heiss <c.heiss@proxmox.com>]

Signed-off-by: Christoph Heiss <c.heiss@proxmox.com>
---
 docs/installation-media.rst | 147 ++++++++++++++++++++++++++++++++++++
 docs/installation.rst       |   2 +
 2 files changed, 149 insertions(+)
 create mode 100644 docs/installation-media.rst

diff --git a/docs/installation-media.rst b/docs/installation-media.rst
new file mode 100644
index 00000000..e109f2ba
--- /dev/null
+++ b/docs/installation-media.rst
@@ -0,0 +1,147 @@
+.. _installation_media:
+
+Installation Media
+------------------
+
+Prepare Installation Media
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Download the installer ISO image from |DOWNLOADS|.
+
+The `Proxmox Backup`_ Server installation media is a hybrid ISO image. It works
+in two ways:
+
+- An ISO image file ready to burn to a CD or DVD.
+
+- A raw sector (IMG) image file ready to copy to a USB flash drive (USB stick).
+
+Using a USB flash drive to install `Proxmox Backup`_ Server is the recommended
+way since it is the faster option.
+
+Prepare a USB Flash Drive as Installation Medium
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The flash drive needs to have at least 1 GB of storage available.
+
+.. note::
+
+   Do not use *UNetbootin*. It does not work with the `Proxmox Backup`_ Server
+   installation image.
+
+.. important::
+
+   Make sure that the USB flash drive is not mounted and does not
+   contain any important data.
+
+Instructions for GNU/Linux
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+On Unix-like operating system use the ``dd`` command to copy the ISO
+image to the USB flash drive. First find the correct device name of the
+USB flash drive (see below). Then run the ``dd`` command.
+
+.. code-block:: console
+
+   # dd bs=1M conv=fdatasync if=./proxmox-backup-server_*.iso of=/dev/XYZ
+
+.. note::
+
+   Be sure to replace ``/dev/XYZ`` with the correct device name and adapt
+   the input filename (*if*) path.
+
+.. caution::
+
+   Be very careful, and do not overwrite the wrong disk!
+
+Find the Correct USB Device Name
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There are two ways to find out the name of the USB flash drive. The
+first one is to compare the last lines of the ``dmesg`` command output
+before and after plugging in the flash drive. The second way is to
+compare the output of the ``lsblk`` command. Open a terminal and run:
+
+.. code-block:: console
+
+   # lsblk
+
+Then plug in your USB flash drive and run the command again:
+
+.. code-block:: console
+
+   # lsblk
+
+A new device will appear. This is the one you want to use. To be on the
+extra safe side check if the reported size matches your USB flash drive.
+
+Instructions for macOS
+~~~~~~~~~~~~~~~~~~~~~~
+
+Open the terminal (query *Terminal* in Spotlight).
+
+Convert the ``.iso`` file to ``.dmg`` format using the convert option of
+``hdiutil``, for example:
+
+.. code-block:: console
+
+   # hdiutil convert proxmox-backup-server_*.iso -format UDRW -o proxmox-backup-server_*.dmg
+
+.. note::
+
+   macOS tends to automatically add ``.dmg`` to the output file name.
+
+To get the current list of devices run the command:
+
+.. code-block:: console
+
+   # diskutil list
+
+Now insert the USB flash drive and run this command again to determine
+which device node has been assigned to it. (e.g., ``/dev/diskX``).
+
+.. code-block:: console
+
+   # diskutil list
+   # diskutil unmountDisk /dev/diskX
+
+.. note::
+
+   replace *X* with the disk number from the last command.
+
+.. code-block:: console
+
+   # sudo dd if=proxmox-backup-server_*.dmg bs=1M of=/dev/rdiskX
+
+.. note::
+
+   *rdiskX*, instead of *diskX*, in the last command is intended. It
+   will increase the write speed.
+
+Instructions for Windows
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Using Etcher
+^^^^^^^^^^^^
+
+Etcher works out of the box. Download Etcher from https://etcher.io. It
+will guide you through the process of selecting the ISO and your USB
+flash drive.
+
+Using Rufus
+^^^^^^^^^^^
+
+Rufus is a more lightweight alternative, but you need to use the **DD
+mode** to make it work. Download Rufus from https://rufus.ie/. Either
+install it or use
+
+.. important::
+
+   Once you click *Start*, you have to click *No* on the dialog asking to
+   download a different version of Grub. In the next dialog select **DD mode**.
+
+Boot your Server from the USB Flash Drive
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Connect the USB flash drive to your server and make sure that booting from USB
+is enabled (check your servers firmware settings). Then follow the steps of the
+:ref:`installation wizard <using_the_installer>`.
diff --git a/docs/installation.rst b/docs/installation.rst
index 449bda8c..27108c99 100644
--- a/docs/installation.rst
+++ b/docs/installation.rst
@@ -7,6 +7,8 @@ Debian_ from the provided package repository.
 
 .. include:: system-requirements.rst
 
+.. include:: installation-media.rst
+
 .. include:: package-repositories.rst
 
 Server Installation
-- 
2.46.0



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel