pmg-installation.adoc

   1 Installation
   2 ============
   3
   4 {pmg} is based on Debian and comes with an installation CD-ROM
   5 which includes a complete Debian ("stretch" for version 5.x) system as
   6 well as all necessary {pmg} packages.
   7
   8 The installer just asks you a few questions, then partitions the local
   9 disk(s), installs all required packages, and configures the system
  10 including a basic network setup. You can get a fully functional system
  11 within a few minutes. This is the preferred and recommended
  12 installation method.
  13
  14 Alternatively, {pmg} can be installed on top of an existing Debian
  15 system.  This option is only recommended for advanced users since
  16 it requires more detailed knowledge about {pmg} and Debian.
  17
  18 Using the {pmg} Installation CD-ROM
  19 -----------------------------------
  20
  21 You can download the ISO from http://www.proxmox.com. It includes the
  22 following:
  23
  24 * Complete operating system (Debian Linux, 64-bit)
  25
  26 * The {pmg} installer, which partitions the hard drive(s) with ext4,
  27   ext3, xfs or ZFS and installs the operating system.
  28
  29 * Linux kernel
  30
  31 * Postfix MTA, ClamAV, Spamassassin and the {pmg} toolset
  32
  33 * Web based management interface for using the toolset
  34
  35 Please burn the downloaded ISO image to a CD or create a
  36 xref:create_bootable_usb[bootable USB stick].
  37
  38 Then insert the installation CD-ROM on the physical host where you want
  39 to install {pmg} and boot from that drive. Immediately afterwards you
  40 can choose the following menu options:
  41
  42 image::images/installer/pmg-grub-menu.png[]
  43
  44 Install {pmg}::
  45
  46 Start normal installation.
  47
  48 Install {pmg} (Debug mode)::
  49
  50 Start installation in debug mode. It opens a shell console at several
  51 installation steps, so that you can debug things if something goes
  52 wrong. Please press `CTRL-D` to exit those debug consoles and continue
  53 installation. This option is mostly for developers and not meant for
  54 general use.
  55
  56 Rescue Boot::
  57
  58 This option allows you to boot an existing installation. It searches
  59 all attached hard disks and, if it finds an existing installation,
  60 boots directly into that disk using the existing Linux kernel. This
  61 can be useful if there are problems with the boot block (grub), or the
  62 BIOS is unable to read the boot block from the disk.
  63
  64 Test Memory::
  65
  66 Runs `memtest86+`. This is useful to check if your memory is
  67 functional and error free.
  68
  69 You normally select *Install {pmg}* to start the installation.
  70
  71 image::images/installer/pmg-select-target-disk.png[]
  72
  73 First step ist to read our EULA (End User License Agreement). After
  74 that you get prompted to select the target hard disk(s).
  75
  76 NOTE: By default, the complete server is used and all existing data is
  77 removed.
  78
  79 The `Options` button lets you select the target file system, which
  80 defaults to `ext4`. The installer uses LVM if you select `ext3`,
  81 `ext4` or `xfs` as file system, and offers additional option to
  82 restrict LVM space (see <<advanced_lvm_options,below>>)
  83
  84 If you have more than one disk, you can also use ZFS as file system.
  85 ZFS supports several software RAID levels, so this is specially useful
  86 if you do not have a hardware RAID controller. The `Options` button
  87 lets you select the ZFS RAID level, and you can choose disks there.
  88
  89 image::images/installer/pmg-select-location.png[]
  90
  91 The next page just ask for basic configuration options like your
  92 location, the time zone and keyboard layout. The location is used to
  93 select a download server near you to speedup updates. The installer is
  94 usually able to auto detect those setting, so you only need to change
  95 them in rare situations when auto detection fails, or when you want to
  96 use some special keyboard layout not commonly used in your country.
  97
  98 image::images/installer/pmg-set-password.png[]
  99
 100 You then need to specify an email address and the superuser (root)
 101 password. The password must have at least 5 characters, but we highly
 102 recommend to use stronger passwords - here are some guidelines:
 103
 104 - Use a minimum password length of 12 to 14 characters.
 105
 106 - Include lowercase and uppercase alphabetic characters, numbers and symbols.
 107
 108 - Avoid character repetition, keyboard patterns, dictionary words, letter or number sequences, usernames, relative or pet names, romantic links (current or past) and biographical information (e.g., ID numbers, ancestors' names or dates).
 109
 110 It is sometimes necessary to send notification to the system
 111 administrator, for example:
 112
 113 - Information about available package updates.
 114
 115 - Error messages from periodic CRON jobs.
 116
 117 All those notification mails will be sent to the specified email
 118 address.
 119
 120 image::images/installer/pmg-setup-network.png[]
 121
 122 The last step is the network configuration. Please note that you can
 123 use either IPv4 or IPv6 here, but not both. If you want to configure a
 124 dual stack node, you can easily do that after installation.
 125
 126 If you press `Next` now, installation starts to format disks, and
 127 copies packages to the target.
 128
 129 image::images/installer/pmg-installation.png[]
 130
 131 Copying packages usually takes a few minutes. Please wait until that
 132 is finished, then reboot the server.
 133
 134 Further configuration is done via the Proxmox web interface. Just
 135 point your browser to the IP address given during installation
 136 (https://youripaddress:8006).
 137
 138 image::images/screenshot/pmg-gui-login-window.png[]
 139
 140 . Login and upload subscription key.
 141 +
 142 NOTE: Default login is "root" and the root password is
 143 defined during the installation process.
 144
 145 . Check the IP configuration and hostname.
 146
 147 . Check and save the Time Zone.
 148
 149 . Check your xref:firewall_settings[Firewall settings].
 150
 151 . Configure {pmg} to forward the incoming SMTP traffic to your Mail
 152 server ('Configuration/Mail Proxy/Default Relay') - 'Default
 153 Relay' is your e-mail server.
 154
 155 . Configure your e-mail server to send all outgoing messages through
 156 your {pmg} ('Smart Host', port 26 by default) - see
 157 xref:fitering_outgoing_mail[Filtering outgoing e-mails].
 158
 159 For detailed deployment scenarios see chapter
 160 xref:chapter_deployment[Planning for Deployment].
 161
 162 If the installation succeeds you have to route all your incoming and
 163 outgoing e-mail traffic to the Mail Gateway. For incoming traffic you
 164 have to configure your firewall and/or DNS settings. For outgoing
 165 traffic you need to change the existing e-mail server configuration.
 166
 167
 168 [[advanced_lvm_options]]
 169 Advanced LVM Configuration Options
 170 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 171
 172 The installer creates a Volume Group (VG) called `pmg`, and additional
 173 Logical Volumes (LVs) called `root` and `swap`. The size of
 174 those volumes can be controlled with:
 175
 176 `hdsize`::
 177
 178 Defines the total HD size to be used. This way you can save free
 179 space on the HD for further partitioning (i.e. for an additional PV
 180 and VG on the same hard disk that can be used for LVM storage).
 181
 182 `swapsize`::
 183
 184 Defines the size of the `swap` volume. The default is the size of the
 185 installed memory, minimum 4 GB and maximum 8 GB. The resulting value cannot
 186 be greater than `hdsize/8`.
 187
 188 `minfree`::
 189
 190 Defines the amount of free space left in LVM volume group `pmg`.
 191 With more than 128GB storage available the default is 16GB, else `hdsize/8`
 192 will be used.
 193 +
 194 NOTE: LVM requires free space in the VG for snapshot creation (not
 195 required for lvmthin snapshots).
 196
 197
 198 ZFS Performance Tips
 199 ~~~~~~~~~~~~~~~~~~~~
 200
 201 ZFS uses a lot of memory, so it is best to add additional RAM if you
 202 want to use ZFS. A good calculation is 4GB plus 1GB RAM for each TB
 203 RAW disk space.
 204
 205 ZFS also provides the feature to use a fast SSD drive as write cache. The
 206 write cache is called the ZFS Intent Log (ZIL). You can add that after
 207 installation using the following command:
 208
 209  zpool add <pool-name> log </dev/path_to_fast_ssd>
 210
 211
 212 Install {pmg} on Debian
 213 -----------------------
 214
 215 {pmg} ships as a set of Debian packages, so you can install it
 216 on top of a normal Debian installation. After configuring the
 217 repositories, you need to run:
 218
 219 [source,bash]
 220 ----
 221 apt-get update
 222 apt-get install proxmox-mailgateway
 223 ----
 224
 225 Installing on top of an existing Debian installation looks easy, but
 226 it presumes that you have correctly installed the base system, and you
 227 know how you want to configure and use the local storage. Network
 228 configuration is also completely up to you.
 229
 230 NOTE: In general, this is not trivial, especially when you use LVM or
 231 ZFS.