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.
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
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.
18 Using the {pmg} Installation CD-ROM
19 -----------------------------------
21 You can download the ISO from http://www.proxmox.com. It includes the
24 * Complete operating system (Debian Linux, 64-bit)
26 * The {pmg} installer, which partitions the hard drive(s) with ext4,
27 ext3, xfs or ZFS and installs the operating system.
31 * Postfix MTA, ClamAV, Spamassassin and the {pmg} toolset
33 * Web based management interface for using the toolset
35 Please burn the downloaded ISO image to a CD or create a
36 xref:create_bootable_usb[bootable USB stick].
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:
42 image::images/installer/pmg-grub-menu.png[]
46 Start normal installation.
48 Install {pmg} (Debug mode)::
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
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.
66 Runs `memtest86+`. This is useful to check if your memory is
67 functional and error free.
69 You normally select *Install {pmg}* to start the installation.
71 image::images/installer/pmg-select-target-disk.png[]
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).
76 NOTE: By default, the complete server is used and all existing data is
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>>)
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.
89 image::images/installer/pmg-select-location.png[]
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.
98 image::images/installer/pmg-set-password.png[]
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:
104 - Use a minimum password length of 12 to 14 characters.
106 - Include lowercase and uppercase alphabetic characters, numbers and symbols.
108 - Avoid character repetition, keyboard patterns, dictionary words, letter or
109 number sequences, usernames, relative or pet names, romantic links (current
110 or past) and biographical information (e.g., ID numbers, ancestors' names or
113 It is sometimes necessary to send notification to the system
114 administrator, for example:
116 - Information about available package updates.
118 - Error messages from periodic CRON jobs.
120 All those notification mails will be sent to the specified email
123 image::images/installer/pmg-setup-network.png[]
125 The last step is the network configuration. Please note that you can
126 use either IPv4 or IPv6 here, but not both. If you want to configure a
127 dual stack node, you can easily do that after installation.
129 If you press `Next` now, installation starts to format disks, and
130 copies packages to the target.
132 image::images/installer/pmg-installation.png[]
134 Copying packages usually takes a few minutes. Please wait until that
135 is finished, then reboot the server.
137 Further configuration is done via the Proxmox web interface. Just
138 point your browser to the IP address given during installation
139 (https://youripaddress:8006).
141 image::images/screenshot/pmg-gui-login-window.png[]
143 . Login and upload subscription key.
145 NOTE: Default login is "root" and the root password is
146 defined during the installation process.
148 . Check the IP configuration and hostname.
150 . Check and save the Time Zone.
152 . Check your xref:firewall_settings[Firewall settings].
154 . Configure {pmg} to forward the incoming SMTP traffic to your Mail
155 server ('Configuration/Mail Proxy/Default Relay') - 'Default
156 Relay' is your e-mail server.
158 . Configure your e-mail server to send all outgoing messages through
159 your {pmg} ('Smart Host', port 26 by default).
161 For detailed deployment scenarios see chapter
162 xref:chapter_deployment[Planning for Deployment].
164 If the installation succeeds you have to route all your incoming and
165 outgoing e-mail traffic to the Mail Gateway. For incoming traffic you
166 have to configure your firewall and/or DNS settings. For outgoing
167 traffic you need to change the existing e-mail server configuration.
170 [[advanced_lvm_options]]
171 Advanced LVM Configuration Options
172 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174 The installer creates a Volume Group (VG) called `pmg`, and additional
175 Logical Volumes (LVs) called `root` and `swap`. The size of
176 those volumes can be controlled with:
180 Defines the total HD size to be used. This way you can save free
181 space on the HD for further partitioning (i.e. for an additional PV
182 and VG on the same hard disk that can be used for LVM storage).
186 Defines the size of the `swap` volume. The default is the size of the
187 installed memory, minimum 4 GB and maximum 8 GB. The resulting value cannot
188 be greater than `hdsize/8`.
192 Defines the amount of free space left in LVM volume group `pmg`.
193 With more than 128GB storage available the default is 16GB, else `hdsize/8`
196 NOTE: LVM requires free space in the VG for snapshot creation (not
197 required for lvmthin snapshots).
203 ZFS uses a lot of memory, so it is best to add additional RAM if you
204 want to use ZFS. A good calculation is 4GB plus 1GB RAM for each TB
207 ZFS also provides the feature to use a fast SSD drive as write cache. The
208 write cache is called the ZFS Intent Log (ZIL). You can add that after
209 installation using the following command:
211 zpool add <pool-name> log </dev/path_to_fast_ssd>
214 include::pmg-usbstick.adoc[]
217 Install {pmg} on Debian
218 -----------------------
220 {pmg} ships as a set of Debian packages, so you can install it
221 on top of a normal Debian installation. After configuring the
222 repositories, you need to run:
227 apt-get install proxmox-mailgateway
230 Installing on top of an existing Debian installation looks easy, but
231 it presumes that you have correctly installed the base system, and you
232 know how you want to configure and use the local storage. Network
233 configuration is also completely up to you.
235 NOTE: In general, this is not trivial, especially when you use LVM or
239 Install {pmg} as Linux Container Appliance
240 ------------------------------------------
242 The full functionality of {pmg} can also run on top of a Debian-based LXC
243 instance. In order to keep the set of installed software, and thus the
244 necessary updates, minimal you can use the `proxmox-mailgateway-container`
245 meta-package. It does not depend on any Linux Kernel, firmware, or components
246 used for booting from bare-metal, like grub2.
248 A ready-to-use appliance template is available through the
249 https://www.proxmox.com/proxmox-ve[Proxmox VE] appliance manager in the `mail`
250 section, so if you already use Proxmox VE you can setup a {pmg} instance in a
253 NOTE: It's recommended to use a static network configuration. If DHCP should be
254 used ensure that the container can always lease the same IP, for example, by
255 reserving one with the containers network MAC address.
257 Additionally you can also install this on top of a normal Debian installation.
258 After configuring the repositories, you need to run:
263 apt-get install proxmox-mailgateway-container
267 [[pmg_package_repositories]]
271 All {debian} based systems use
272 http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as package
273 management tool. The list of repositories is defined in
274 `/etc/apt/sources.list` and `.list` files found inside
275 `/etc/apt/sources.d/`. Updates can be installed directly using
276 `apt-get`, or via the GUI.
278 Apt `sources.list` files list one package repository per line, with
279 the most preferred source listed first. Empty lines are ignored, and a
280 `#` character anywhere on a line marks the remainder of that line as a
281 comment. The information available from the configured sources is
282 acquired by `apt-get update`.
284 .File `/etc/apt/sources.list`
286 deb http://ftp.debian.org/debian stretch main contrib
288 deb http://ftp.debian.org/debian stretch-updates main contrib
291 deb http://security.debian.org stretch/updates main contrib
294 In addition, {pmg} provides three different package repositories.
297 {pmg} Enterprise Repository
298 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
300 This is the default, stable and recommended repository, available for
301 all {pmg} subscription users. It contains the most stable packages,
302 and is suitable for production use. The `pmg-enterprise` repository is
305 .File `/etc/apt/sources.list.d/pmg-enterprise.list`
307 deb https://enterprise.proxmox.com/debian/pmg stretch pmg-enterprise
310 As soon as updates are available, the `root@pam` user is notified via
311 email about the available new packages. On the GUI, the change-log of
312 each package can be viewed (if available), showing all details of the
313 update. So you will never miss important security fixes.
315 Please note that and you need a valid subscription key to access this
316 repository. We offer different support levels, and you can find further
317 details at {pricing-url}.
319 NOTE: You can disable this repository by commenting out the above line
320 using a `#` (at the start of the line). This prevents error messages
321 if you do not have a subscription key. Please configure the
322 `pmg-no-subscription` repository in that case.
325 {pmg} No-Subscription Repository
326 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
328 As the name suggests, you do not need a subscription key to access
329 this repository. It can be used for testing and non-production
330 use. Its not recommended to run on production servers, as these
331 packages are not always heavily tested and validated.
333 We recommend to configure this repository in `/etc/apt/sources.list`.
335 .File `/etc/apt/sources.list`
337 deb http://ftp.debian.org/debian stretch main contrib
339 # PMG pmg-no-subscription repository provided by proxmox.com,
340 # NOT recommended for production use
341 deb http://download.proxmox.com/debian/pmg stretch pmg-no-subscription
344 deb http://security.debian.org stretch/updates main contrib
348 {pmg} Test Repository
349 ~~~~~~~~~~~~~~~~~~~~~
351 Finally, there is a repository called `pmgtest`. This one contains the
352 latest packages and is heavily used by developers to test new
353 features. As usual, you can configure this using
354 `/etc/apt/sources.list` by adding the following line:
356 .sources.list entry for `pmgtest`
358 deb http://download.proxmox.com/debian/pmg stretch pmgtest
361 WARNING: the `pmgtest` repository should (as the name implies) only be used
362 for testing new features or bug fixes.
368 We use GnuPG to sign the `Release` files inside those repositories,
369 and APT uses that signatures to verify that all packages are from a
372 The key used for verification is already installed if you install from
373 our installation CD. If you install by other means, you can manually
374 download the key with:
376 # wget http://download.proxmox.com/debian/proxmox-ve-release-5.x.gpg -O /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
378 Please verify the checksum afterwards:
381 # sha512sum /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
382 ffb95f0f4be68d2e753c8875ea2f8465864a58431d5361e88789568673551501ae574283a4e0492f17d79dc67edfb173a56a6304dea39e01f249ebdabc9f074a /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
388 # md5sum /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg
389 511d36d0f1350c01c42a3dc9f3c27939 /etc/apt/trusted.gpg.d/proxmox-ve-release-5.x.gpg