[pmg-devel] [PATCH docs 1/2] install: usb: use updated instructions from PVE
Aaron Lauterer
a.lauterer at proxmox.com
Fri May 15 14:44:09 CEST 2020
The instructions for a bootable USB flash drive in the PVE docs have
been worked on to improve the phrasing and cover current tools for
Windows which we also want in the PMG docs.
Signed-off-by: Aaron Lauterer <a.lauterer at proxmox.com>
---
pmg-installation-media.adoc | 119 ++++++++++++++++++++++++++++++++++++
pmg-installation.adoc | 6 +-
pmg-usbstick.adoc | 118 -----------------------------------
3 files changed, 121 insertions(+), 122 deletions(-)
create mode 100644 pmg-installation-media.adoc
delete mode 100644 pmg-usbstick.adoc
diff --git a/pmg-installation-media.adoc b/pmg-installation-media.adoc
new file mode 100644
index 0000000..f25e395
--- /dev/null
+++ b/pmg-installation-media.adoc
@@ -0,0 +1,119 @@
+[[installation_prepare_media]]
+Prepare Installation Media
+--------------------------
+
+Download the installer ISO image from: {website}en/downloads/category/proxmox-mail-gateway
+
+The {pmg} 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 {pmg} is the recommended way because 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 {pmg} 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.
+
+----
+# dd bs=1M conv=fdatasync if=./proxmox-mailgateway_*.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:
+
+----
+# lsblk
+----
+
+Then plug in your USB flash drive and run the command again:
+
+----
+# 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 .img using the convert option of `hdiutil` for example.
+
+----
+# hdiutil convert -format UDRW -o proxmox-mailgateway_*.dmg proxmox-ve_*.iso
+----
+
+TIP: macOS tends to automatically add '.dmg' to the output file name.
+
+To get the current list of devices run the command:
+
+----
+# 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).
+
+----
+# diskutil list
+# diskutil unmountDisk /dev/diskX
+----
+
+NOTE: replace X with the disk number from the last command.
+
+----
+# sudo dd if=proxmox-mailgateway_*.dmg of=/dev/rdiskX bs=1m
+----
+
+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 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
+the portable version. Select the destination drive and the {pmg} ISO file.
+
+IMPORTANT: Once you 'Start' you have to click 'No' on the dialog asking to
+download a different version of GRUB. In the next dialog select the 'DD' mode.
+
diff --git a/pmg-installation.adoc b/pmg-installation.adoc
index 0f0021e..6c4254e 100644
--- a/pmg-installation.adoc
+++ b/pmg-installation.adoc
@@ -34,7 +34,7 @@ following:
* Web-based management interface for using the toolset
Please burn the downloaded ISO image to a CD or create a
-xref:create_bootable_usb[bootable USB stick].
+xref:installation_prepare_media[bootable USB flash drive].
Then insert the installation CD-ROM on the physical host where you want
to install {pmg} and boot from that drive. Afterwards you
@@ -218,9 +218,7 @@ the installation using the following command:
zpool add <pool-name> log </dev/path_to_fast_ssd>
-
-include::pmg-usbstick.adoc[]
-
+include::pmg-installation-media.adoc[]
[[pmg_install_on_debian]]
Install {pmg} on Debian
diff --git a/pmg-usbstick.adoc b/pmg-usbstick.adoc
deleted file mode 100644
index f226ea8..0000000
--- a/pmg-usbstick.adoc
+++ /dev/null
@@ -1,118 +0,0 @@
-[[create_bootable_usb]]
-Install from USB Stick
-----------------------
-
-The {pmg} installation media is now a hybrid ISO image, working in two
-ways:
-
-* An ISO image file ready to burn on CD
-
-* A raw sector (IMG) image file ready to directly copy to flash media
- (USB Stick)
-
-Using USB sticks is faster and more environmental friendly and
-therefore the recommended way to install {pmg}.
-
-
-Prepare a USB flash drive as install medium
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-In order to boot the installation media, copy the ISO image to a USB
-media.
-
-First download the ISO image from
-https://www.proxmox.com/en/downloads/category/proxmox-mail-gateway
-
-You need at least a 1 GB USB media.
-
-NOTE: Using UNetbootin or Rufus does not work.
-
-IMPORTANT: Make sure that the USB media is not mounted and does not
-contain any important data.
-
-
-Instructions for GNU/Linux
-~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You can simply use `dd` on UNIX like systems. First download the ISO
-image, then plug in the USB stick. You need to find out what device
-name gets assigned to the USB stick (see below). Then run:
-
-----
-dd if=proxmox-mailgateway_*.iso of=/dev/XYZ bs=1M
-----
-
-NOTE: Be sure to replace /dev/XYZ with the correct device name.
-
-CAUTION: Be very careful, and do not overwrite the hard disk!
-
-
-Find Correct USB Device Name
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-You can compare the last lines of 'dmesg' command before and after the
-insertion, or use the 'lsblk' command. Open a terminal and run:
-
-----
-lsblk
-----
-
-Then plug in your USB media and run the command again:
-
-----
-lsblk
-----
-
-A new device will appear, and this is the USB device you want to use.
-
-
-Instructions for OSX
-~~~~~~~~~~~~~~~~~~~~
-
-Open the terminal (query Terminal in Spotlight).
-
-Convert the .iso file to .img using the convert option of hdiutil for example.
-
-----
-hdiutil convert -format UDRW -o proxmox-mailgateway_*.dmg proxmox-mailgateway_*.iso
-----
-
-TIP: OS X tends to put the .dmg ending on the output file automatically.
-
-To get the current list of devices run the command again:
-
-----
-diskutil list
-----
-
-Now insert your USB flash media and run this command again to
-determine the device node assigned to your flash media
-(e.g. /dev/diskX).
-
-----
-diskutil list
-
-diskutil unmountDisk /dev/diskX
-----
-
-NOTE: replace X with the disk number from the last command.
-
-----
-sudo dd if=proxmox-mailgateway_*.dmg of=/dev/rdiskN bs=1m
-----
-
-
-Instructions for Windows
-~~~~~~~~~~~~~~~~~~~~~~~~
-
-Download Etcher from https://etcher.io , select the ISO and your USB Drive.
-
-If this doesn't work, alternatively use the OSForensics USB
-installer from https://www.osforensics.com/portability.html
-
-
-Boot your server from USB media
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Connect your USB media to your server and make sure that the server
-boots from USB (see server BIOS). Then follow the installation wizard.
--
2.20.1
More information about the pmg-devel
mailing list