]>
Commit | Line | Data |
---|---|---|
03c03402 DM |
1 | Installation |
2 | ============ | |
3 | ||
8eb27e2f TL |
4 | {pmg} is based on Debian. This is why the install disk images (ISO files) |
5 | provided by Proxmox include a complete Debian system as well as all necessary | |
6 | {pmg} packages. | |
03c03402 | 7 | |
8eb27e2f TL |
8 | TIP: See the xref:faq-support-table[support table in the FAQ] for the |
9 | relationship between {pmg} releases and Debian releases. | |
03c03402 | 10 | |
c78dc3bb | 11 | The installer will guide you through the setup, allowing you to partition the local |
8eb27e2f TL |
12 | disk(s), apply basic system configurations (for example, timezone, language, |
13 | network) and install all required packages. This process should not take more | |
14 | than a few minutes. Installing with the provided ISO is the recommended method | |
15 | for new and existing users. | |
16 | ||
17 | Alternatively, {pmg} can be installed on top of an existing Debian system. This | |
18 | option is only recommended for advanced users because detailed knowledge about | |
19 | {pmg} is required. | |
03c03402 | 20 | |
dfcaa012 AL |
21 | include::pmg-installation-media.adoc[] |
22 | ||
39abbce4 | 23 | [[pmg_install_iso]] |
03c03402 DM |
24 | Using the {pmg} Installation CD-ROM |
25 | ----------------------------------- | |
26 | ||
dfcaa012 | 27 | The installer ISO image includes the following: |
03c03402 DM |
28 | |
29 | * Complete operating system (Debian Linux, 64-bit) | |
30 | ||
b2d388d4 | 31 | * The {pmg} installer, which partitions the hard drive(s) with ext4, |
8eb27e2f | 32 | XFS or ZFS and installs the operating system |
03c03402 DM |
33 | |
34 | * Linux kernel | |
35 | ||
36 | * Postfix MTA, ClamAV, Spamassassin and the {pmg} toolset | |
37 | ||
582a64ad | 38 | * Web-based management interface for using the toolset |
03c03402 | 39 | |
b2d388d4 | 40 | |
dfcaa012 AL |
41 | Please insert the xref:installation_prepare_media[prepared installation media] |
42 | (for example, USB flash drive or CD-ROM) and boot from it. | |
43 | ||
44 | TIP: Make sure that booting from the installation medium (for example, USB) is | |
45 | enabled in your servers firmware settings. | |
46 | ||
bf99325b DW |
47 | After choosing the correct entry (for example, Boot from USB) the {pmg} menu |
48 | will be displayed, and one of the following options can be selected: | |
03c03402 DM |
49 | |
50 | image::images/installer/pmg-grub-menu.png[] | |
51 | ||
52 | Install {pmg}:: | |
53 | ||
54 | Start normal installation. | |
55 | ||
56 | Install {pmg} (Debug mode):: | |
57 | ||
bf99325b DW |
58 | Start installation in debug mode. This opens a shell console at various stages |
59 | throughout the installation, so that you can debug issues, if something goes | |
60 | wrong. You can press `CTRL-D` to exit the debug console and continue the | |
61 | installation. This option is mostly for developers and not meant for general | |
62 | use. | |
03c03402 DM |
63 | |
64 | Rescue Boot:: | |
65 | ||
66 | This option allows you to boot an existing installation. It searches | |
67 | all attached hard disks and, if it finds an existing installation, | |
68 | boots directly into that disk using the existing Linux kernel. This | |
69 | can be useful if there are problems with the boot block (grub), or the | |
70 | BIOS is unable to read the boot block from the disk. | |
71 | ||
72 | Test Memory:: | |
73 | ||
74 | Runs `memtest86+`. This is useful to check if your memory is | |
75 | functional and error free. | |
76 | ||
dc69da07 | 77 | You normally select *Install {pmg}* to start the installation. |
03c03402 | 78 | |
dc69da07 | 79 | image::images/installer/pmg-select-target-disk.png[] |
03c03402 | 80 | |
bf99325b DW |
81 | The first step is to read our EULA (End User License Agreement). Following |
82 | this, you can select the target hard disk(s) for the installation. | |
03c03402 | 83 | |
582a64ad OB |
84 | CAUTION: By default, the whole server is used and all existing data is removed. |
85 | Make sure there is no important data on the server before proceeding with the | |
86 | installation. | |
03c03402 | 87 | |
03c03402 | 88 | The `Options` button lets you select the target file system, which |
12908dd2 | 89 | defaults to `ext4`. The installer uses LVM if you select |
bf99325b | 90 | `ext4` or `xfs` as a file system, and offers additional options to |
03c03402 DM |
91 | restrict LVM space (see <<advanced_lvm_options,below>>) |
92 | ||
bf99325b DW |
93 | If you have more than one disk, you can also use ZFS as a file system. |
94 | ZFS supports several software RAID levels, which is particularly useful | |
03c03402 | 95 | if you do not have a hardware RAID controller. The `Options` button |
bf99325b | 96 | lets you choose the ZFS RAID level and select which disks will be used. |
03c03402 | 97 | |
dc69da07 DM |
98 | image::images/installer/pmg-select-location.png[] |
99 | ||
582a64ad | 100 | The next page asks for basic configuration options like your |
bf99325b DW |
101 | location, timezone, and keyboard layout. The location is used to |
102 | select a nearby download server, in order to increase the speed of updates. | |
103 | The installer is usually able to auto-detect these settings, so you only need to | |
104 | change them in rare situations when auto-detection fails, or when you want to | |
582a64ad | 105 | use a keyboard layout not commonly used in your country. |
dc69da07 DM |
106 | |
107 | image::images/installer/pmg-set-password.png[] | |
108 | ||
109 | You then need to specify an email address and the superuser (root) | |
110 | password. The password must have at least 5 characters, but we highly | |
111 | recommend to use stronger passwords - here are some guidelines: | |
112 | ||
113 | - Use a minimum password length of 12 to 14 characters. | |
114 | ||
115 | - Include lowercase and uppercase alphabetic characters, numbers and symbols. | |
116 | ||
60522152 TL |
117 | - Avoid character repetition, keyboard patterns, dictionary words, letter or |
118 | number sequences, usernames, relative or pet names, romantic links (current | |
119 | or past) and biographical information (e.g., ID numbers, ancestors' names or | |
120 | dates). | |
dc69da07 | 121 | |
aecce55c TL |
122 | It is sometimes necessary to send notification to the system administrator, for |
123 | example: | |
dc69da07 DM |
124 | |
125 | - Information about available package updates. | |
126 | ||
bf99325b | 127 | - Error messages from periodic cron jobs. |
dc69da07 | 128 | |
aecce55c | 129 | All those notification mails will be sent to the specified email address. |
dc69da07 DM |
130 | |
131 | image::images/installer/pmg-setup-network.png[] | |
03c03402 | 132 | |
aecce55c TL |
133 | The next step is the network configuration. Please note that you can use either |
134 | IPv4 or IPv6 here, but not both. If you want to configure a dual stack node, | |
bf99325b | 135 | you can easily do that after the installation. |
03c03402 | 136 | |
f6249b79 TL |
137 | image::images/installer/pmg-summary.png[] |
138 | ||
aecce55c TL |
139 | When you press `Next`, you will see an overview of your entered configuration. |
140 | Please re-check every setting, you can still use the `Previous` button to go | |
141 | back and edit any settings. | |
f6249b79 | 142 | |
bf99325b DW |
143 | After clicking `Install`, the installer will begin to format and copy packages |
144 | to the target disk(s). | |
dc69da07 DM |
145 | |
146 | image::images/installer/pmg-installation.png[] | |
147 | ||
bf99325b DW |
148 | Copying the packages usually takes several minutes. When this is |
149 | finished, you can reboot the server. | |
03c03402 | 150 | |
bf99325b | 151 | Further configuration is done via the {pmg} web interface: |
f03ead41 SI |
152 | |
153 | [thumbnail="pmg-gui-login-window.png"] | |
03c03402 | 154 | |
bf99325b | 155 | . Point your browser to the IP address given during the installation |
f03ead41 | 156 | (https://youripaddress:8006). |
b5b01ac3 | 157 | |
bf99325b | 158 | . Log in and upload your subscription key. |
b2d388d4 | 159 | + |
bf99325b | 160 | NOTE: The default login is "root", and the password is the one chosen during the |
aecce55c | 161 | installation. |
03c03402 | 162 | |
b2d388d4 DM |
163 | . Check the IP configuration and hostname. |
164 | ||
bf99325b | 165 | . Check the timezone. |
b2d388d4 DM |
166 | |
167 | . Check your xref:firewall_settings[Firewall settings]. | |
168 | ||
bf99325b | 169 | . Configure {pmg} to forward the incoming SMTP traffic to your mail |
b2d388d4 | 170 | server ('Configuration/Mail Proxy/Default Relay') - 'Default |
09e283f2 | 171 | Relay' is your email server. |
b2d388d4 | 172 | |
09e283f2 | 173 | . Configure your email server to send all outgoing messages through |
303ee757 | 174 | your {pmg} ('Smart Host', port 26 by default). |
b2d388d4 DM |
175 | |
176 | For detailed deployment scenarios see chapter | |
177 | xref:chapter_deployment[Planning for Deployment]. | |
178 | ||
bf99325b DW |
179 | After the installation, you have to route all your incoming and |
180 | outgoing email traffic to {pmg}. For incoming traffic, you | |
b2d388d4 | 181 | have to configure your firewall and/or DNS settings. For outgoing |
09e283f2 | 182 | traffic you need to change the existing email server configuration. |
b2d388d4 | 183 | |
03c03402 DM |
184 | |
185 | [[advanced_lvm_options]] | |
186 | Advanced LVM Configuration Options | |
187 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
188 | ||
189 | The installer creates a Volume Group (VG) called `pmg`, and additional | |
190 | Logical Volumes (LVs) called `root` and `swap`. The size of | |
191 | those volumes can be controlled with: | |
192 | ||
193 | `hdsize`:: | |
194 | ||
582a64ad OB |
195 | Defines the total disk size to be used. This way you can save free |
196 | space on the disk for further partitioning (i.e. for an additional PV | |
197 | and VG on the same disk that can be used for LVM storage). | |
03c03402 DM |
198 | |
199 | `swapsize`:: | |
200 | ||
201 | Defines the size of the `swap` volume. The default is the size of the | |
bf99325b DW |
202 | installed memory. The minimum is 4 GB and the maximum is 8 GB. The resulting |
203 | value cannot be greater than `hdsize/8`. | |
03c03402 | 204 | |
03c03402 DM |
205 | `minfree`:: |
206 | ||
bf99325b DW |
207 | Defines the amount of free space that should be left in the LVM volume group |
208 | `pmg`. With more than 128GB storage available, the default is 16GB, otherwise | |
209 | `hdsize/8` will be used. | |
03c03402 DM |
210 | + |
211 | NOTE: LVM requires free space in the VG for snapshot creation (not | |
212 | required for lvmthin snapshots). | |
213 | ||
214 | ||
215 | ZFS Performance Tips | |
216 | ~~~~~~~~~~~~~~~~~~~~ | |
217 | ||
218 | ZFS uses a lot of memory, so it is best to add additional RAM if you | |
219 | want to use ZFS. A good calculation is 4GB plus 1GB RAM for each TB | |
220 | RAW disk space. | |
221 | ||
bf99325b | 222 | ZFS also provides the ability to use a fast SSD drive as write cache. The |
03c03402 | 223 | write cache is called the ZFS Intent Log (ZIL). You can add that after |
582a64ad | 224 | the installation using the following command: |
03c03402 DM |
225 | |
226 | zpool add <pool-name> log </dev/path_to_fast_ssd> | |
227 | ||
3372775f | 228 | |
39abbce4 | 229 | [[pmg_install_on_debian]] |
03c03402 DM |
230 | Install {pmg} on Debian |
231 | ----------------------- | |
232 | ||
233 | {pmg} ships as a set of Debian packages, so you can install it | |
234 | on top of a normal Debian installation. After configuring the | |
bf99325b | 235 | xref:pmg_package_repositories[package repositories], you need to run: |
03c03402 DM |
236 | |
237 | [source,bash] | |
238 | ---- | |
3e2d2270 TL |
239 | apt update |
240 | apt install proxmox-mailgateway | |
03c03402 DM |
241 | ---- |
242 | ||
bf99325b | 243 | Installing on top of an existing Debian installation seems easy, but |
582a64ad | 244 | it assumes that you have correctly installed the base system, and you |
03c03402 DM |
245 | know how you want to configure and use the local storage. Network |
246 | configuration is also completely up to you. | |
247 | ||
248 | NOTE: In general, this is not trivial, especially when you use LVM or | |
249 | ZFS. | |
e3eaa56a DM |
250 | |
251 | ||
39abbce4 | 252 | [[pmg_install_on_debian_container]] |
bf99325b | 253 | Install {pmg} as a Linux Container Appliance |
3fc72cc0 | 254 | -------------------------------------------- |
c13d3d4f | 255 | |
bf99325b | 256 | {pmg} can also run inside a Debian-based LXC |
c13d3d4f | 257 | instance. In order to keep the set of installed software, and thus the |
582a64ad | 258 | necessary updates minimal, you can use the `proxmox-mailgateway-container` |
bf99325b | 259 | meta-package. This does not depend on any Linux kernel, firmware, or components |
c13d3d4f | 260 | used for booting from bare-metal, like grub2. |
17a13972 | 261 | |
bf99325b DW |
262 | A ready-to-use appliance template is available through the `mail` section of the |
263 | https://www.proxmox.com/proxmox-ve[Proxmox VE] appliance manager, so if you | |
264 | already use Proxmox VE, you can set up a {pmg} instance in minutes. | |
17a13972 | 265 | |
bf99325b DW |
266 | NOTE: It's recommended to use a static network configuration. If DHCP must be |
267 | used, ensure that the container always leases the same IP, for example, by | |
268 | reserving one with the container's network MAC address. | |
5991f9eb | 269 | |
bf99325b | 270 | Additionally, you can install this on top of a container-based Debian |
3e2d2270 | 271 | installation. After configuring the |
bf99325b | 272 | xref:pmg_package_repositories[package repositories], you need to run: |
3e2d2270 TL |
273 | |
274 | [source,bash] | |
275 | ---- | |
276 | apt update | |
277 | apt install proxmox-mailgateway-container | |
278 | ---- | |
5991f9eb | 279 | |
e3eaa56a DM |
280 | [[pmg_package_repositories]] |
281 | Package Repositories | |
282 | -------------------- | |
283 | ||
0261cbde FE |
284 | {pmg} uses http://en.wikipedia.org/wiki/Advanced_Packaging_Tool[APT] as its |
285 | package management tool like any other Debian-based system. | |
286 | ||
287 | Repositories in {pmg} | |
288 | ~~~~~~~~~~~~~~~~~~~~~ | |
289 | ||
290 | Repositories are a collection of software packages. They can be used to install | |
291 | new software, but are also important to get new updates. | |
292 | ||
293 | NOTE: You need valid Debian and Proxmox repositories to get the latest | |
294 | security updates, bug fixes and new features. | |
295 | ||
296 | APT Repositories are defined in the file `/etc/apt/sources.list` and in `.list` | |
297 | files placed in `/etc/apt/sources.list.d/`. | |
298 | ||
299 | Repository Management | |
300 | ^^^^^^^^^^^^^^^^^^^^^ | |
301 | ||
302 | [thumbnail="pmg-gui-admin-repositories.png"] | |
303 | ||
304 | Since {pmg} 7.0 you can check the repository state in the web interface. The | |
305 | 'Dashboard' shows a high level status overview, while the separate 'Repository' | |
306 | panel (accessible via 'Administration') shows in-depth status and list of all | |
307 | configured repositories. | |
308 | ||
309 | Basic repository management, for example, activating or deactivating a | |
310 | repository, is also supported. | |
311 | ||
312 | Sources.list | |
313 | ^^^^^^^^^^^^ | |
314 | ||
315 | In a `sources.list` file, each line defines a package repository. The preferred | |
316 | source must come first. Empty lines are ignored. A `#` character anywhere on a | |
317 | line marks the remainder of that line as a comment. The available packages from | |
318 | a repository are acquired by running `apt update`. Updates can be installed | |
319 | directly using `apt`, or via the GUI (Administration -> Updates). | |
e3eaa56a DM |
320 | |
321 | .File `/etc/apt/sources.list` | |
322 | ---- | |
483f7a35 TL |
323 | # basic Debian repositories: |
324 | deb http://ftp.debian.org/debian bullseye main contrib | |
325 | deb http://ftp.debian.org/debian bullseye-updates main contrib | |
aedc8192 | 326 | |
e3eaa56a | 327 | # security updates |
483f7a35 TL |
328 | deb http://security.debian.org/debian-security bullseye-security main contrib |
329 | ||
330 | # Proxmox Mail Gateway repo required too - see below! | |
e3eaa56a DM |
331 | ---- |
332 | ||
0261cbde | 333 | {pmg} provides three different package repositories. |
e3eaa56a DM |
334 | |
335 | ||
336 | {pmg} Enterprise Repository | |
337 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
338 | ||
339 | This is the default, stable and recommended repository, available for | |
340 | all {pmg} subscription users. It contains the most stable packages, | |
341 | and is suitable for production use. The `pmg-enterprise` repository is | |
342 | enabled by default: | |
343 | ||
344 | .File `/etc/apt/sources.list.d/pmg-enterprise.list` | |
345 | ---- | |
483f7a35 | 346 | deb https://enterprise.proxmox.com/debian/pmg bullseye pmg-enterprise |
e3eaa56a DM |
347 | ---- |
348 | ||
349 | As soon as updates are available, the `root@pam` user is notified via | |
bf99325b | 350 | email about the newly available packages. From the GUI, the change-log of |
e3eaa56a | 351 | each package can be viewed (if available), showing all details of the |
bf99325b | 352 | update. Thus, you will never miss important security fixes. |
e3eaa56a | 353 | |
bf99325b DW |
354 | Please note that you need a valid subscription key to access this |
355 | repository. We offer different support levels, which you can find further | |
356 | details about at {pricing-url}. | |
e3eaa56a DM |
357 | |
358 | NOTE: You can disable this repository by commenting out the above line | |
bf99325b | 359 | using a `#` (at the start of the line). This prevents error messages, |
e3eaa56a | 360 | if you do not have a subscription key. Please configure the |
bf99325b | 361 | `pmg-no-subscription` repository in this case. |
e3eaa56a DM |
362 | |
363 | ||
364 | {pmg} No-Subscription Repository | |
365 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
366 | ||
367 | As the name suggests, you do not need a subscription key to access | |
368 | this repository. It can be used for testing and non-production | |
bf99325b | 369 | use. It's not recommended to use this on production servers, as these |
e3eaa56a DM |
370 | packages are not always heavily tested and validated. |
371 | ||
bf99325b | 372 | We recommend configuring this repository in `/etc/apt/sources.list`. |
e3eaa56a DM |
373 | |
374 | .File `/etc/apt/sources.list` | |
375 | ---- | |
483f7a35 TL |
376 | deb http://ftp.debian.org/debian bullseye main contrib |
377 | deb http://ftp.debian.org/debian bullseye-updates main contrib | |
378 | ||
379 | # security updates | |
380 | deb http://security.debian.org/debian-security bullseye-security main contrib | |
e3eaa56a DM |
381 | |
382 | # PMG pmg-no-subscription repository provided by proxmox.com, | |
383 | # NOT recommended for production use | |
483f7a35 | 384 | deb http://download.proxmox.com/debian/pmg bullseye pmg-no-subscription |
e3eaa56a DM |
385 | ---- |
386 | ||
387 | ||
388 | {pmg} Test Repository | |
389 | ~~~~~~~~~~~~~~~~~~~~~ | |
390 | ||
bf99325b DW |
391 | Finally, there is a repository called `pmgtest`. This contains the |
392 | latest packages, and is heavily used by developers to test new | |
393 | features. As with before, you can configure this using | |
e3eaa56a DM |
394 | `/etc/apt/sources.list` by adding the following line: |
395 | ||
396 | .sources.list entry for `pmgtest` | |
397 | ---- | |
483f7a35 | 398 | deb http://download.proxmox.com/debian/pmg bullseye pmgtest |
e3eaa56a DM |
399 | ---- |
400 | ||
582a64ad | 401 | WARNING: the `pmgtest` repository should only be used |
e3eaa56a DM |
402 | for testing new features or bug fixes. |
403 | ||
404 | ||
405 | SecureApt | |
406 | ~~~~~~~~~ | |
407 | ||
bf99325b DW |
408 | We use GnuPG to sign the `Release` files inside these repositories, |
409 | and APT uses these signatures to verify that all packages are from a | |
e3eaa56a DM |
410 | trusted source. |
411 | ||
bf99325b DW |
412 | The key used for verification is already installed, if you install from |
413 | our installation CD. If you install via another means, you can manually | |
e3eaa56a DM |
414 | download the key with: |
415 | ||
483f7a35 TL |
416 | ---- |
417 | # wget https://enterprise.proxmox.com/debian/proxmox-release-bullseye.gpg -O /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg | |
418 | ---- | |
e3eaa56a | 419 | |
483f7a35 | 420 | Verify the checksum afterwards with the `sha512sum` CLI tool: |
e3eaa56a DM |
421 | |
422 | ---- | |
483f7a35 TL |
423 | # sha512sum /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg |
424 | 7fb03ec8a1675723d2853b84aa4fdb49a46a3bb72b9951361488bfd19b29aab0a789a4f8c7406e71a69aabbc727c936d3549731c4659ffa1a08f44db8fdcebfa /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg | |
e3eaa56a DM |
425 | ---- |
426 | ||
483f7a35 | 427 | or the `md5sum` CLI tool: |
e3eaa56a DM |
428 | |
429 | ---- | |
483f7a35 TL |
430 | # md5sum /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg |
431 | bcc35c7173e0845c0d6ad6470b70f50e /etc/apt/trusted.gpg.d/proxmox-release-bullseye.gpg | |
e3eaa56a DM |
432 | ---- |
433 | ||
434 | ||
96806766 SI |
435 | Other Repository Sources |
436 | ~~~~~~~~~~~~~~~~~~~~~~~~ | |
437 | ||
438 | Certain software cannot be made available in the `main` and `contrib` | |
439 | areas of the {debian} archives, since it does not adhere to the Debian | |
440 | Free Software Guidelines (DFSG). These are distributed in the | |
441 | {debian_nonfree_archive_area}. For {pmg} two packages from the `non-free` area | |
442 | are needed in order to support the RAR archive format: | |
443 | ||
444 | * `p7zip-rar` for matching xref:pmg_mailfilter_what[Archive Objects] in the | |
445 | xref:chapter_mailfilter[Rule system] | |
446 | ||
447 | * `libclamunrar` for detecting viruses in RAR archives. | |
448 | ||
5479707c | 449 | .Additional sources.list entry for `non-free` |
96806766 | 450 | ---- |
483f7a35 TL |
451 | deb http://deb.debian.org/debian/ bullseye non-free |
452 | deb http://security.debian.org/debian-security bullseye-security non-free | |
453 | deb http://deb.debian.org/debian/ bullseye-updates non-free | |
96806766 | 454 | ---- |
5479707c | 455 | |
bf99325b | 456 | Following this, you can install the required packages with: |
5479707c TL |
457 | |
458 | ---- | |
459 | apt update | |
460 | apt install libclamunrar p7zip-rar | |
461 | ---- |