]>
Commit | Line | Data |
---|---|---|
9a6dc394 | 1 | [[chapter_installation]] |
32caab0e AL |
2 | Installing {pve} |
3 | ================ | |
194d2f29 | 4 | ifndef::manvolnum[] |
5f09af76 | 5 | :pve-toplevel: |
194d2f29 DM |
6 | endif::manvolnum[] |
7 | ifdef::wiki[] | |
cb84ed18 | 8 | :title: Installation |
5f09af76 DM |
9 | endif::wiki[] |
10 | ||
32caab0e | 11 | {pve} is based on Debian. This is why the install disk images (ISO files) |
bdf0aff2 TL |
12 | provided by Proxmox include a complete Debian system as well as all necessary |
13 | {pve} packages. | |
14 | ||
15 | TIP: See the xref:faq-support-table[support table in the FAQ] for the | |
7f7446cf | 16 | relationship between {pve} releases and Debian releases. |
2d99ce9b | 17 | |
19d1b3de SI |
18 | The installer will guide you through the setup, allowing you to partition the |
19 | local disk(s), apply basic system configurations (for example, timezone, | |
20 | language, network) and install all required packages. This process should not | |
21 | take more than a few minutes. Installing with the provided ISO is the | |
22 | recommended method for new and existing users. | |
d91f8c1e | 23 | |
32caab0e AL |
24 | Alternatively, {pve} can be installed on top of an existing Debian system. This |
25 | option is only recommended for advanced users because detailed knowledge about | |
26 | {pve} is required. | |
d91f8c1e | 27 | |
bc1c71d4 DM |
28 | ifndef::wiki[] |
29 | ||
30 | include::pve-system-requirements.adoc[] | |
31 | ||
44ea3fd6 TL |
32 | include::pve-installation-media.adoc[] |
33 | ||
bc1c71d4 DM |
34 | endif::wiki[] |
35 | ||
5eba0743 | 36 | |
9a6dc394 | 37 | [[installation_installer]] |
2c6fed66 TM |
38 | Using the {pve} Installer |
39 | ------------------------- | |
d91f8c1e | 40 | |
44ea3fd6 | 41 | The installer ISO image includes the following: |
115aef16 | 42 | |
e69c1847 DM |
43 | * Complete operating system (Debian Linux, 64-bit) |
44 | ||
7f7446cf TL |
45 | * The {pve} installer, which partitions the local disk(s) with ext4, XFS, |
46 | BTRFS (technology preview), or ZFS and installs the operating system. | |
e69c1847 | 47 | |
9a6dc394 | 48 | * {pve} Linux kernel with KVM and LXC support |
e69c1847 | 49 | |
9a6dc394 TL |
50 | * Complete toolset for administering virtual machines, containers, the host |
51 | system, clusters and all necessary resources | |
e69c1847 | 52 | |
32caab0e | 53 | * Web-based management interface |
115aef16 | 54 | |
bc27b00c TL |
55 | NOTE: All existing data on the for installation selected drives will be removed |
56 | during the installation process. The installer does not add boot menu entries | |
57 | for other operating systems. | |
078924cd | 58 | |
44ea3fd6 TL |
59 | Please insert the xref:installation_prepare_media[prepared installation media] |
60 | (for example, USB flash drive or CD-ROM) and boot from it. | |
61 | ||
62 | TIP: Make sure that booting from the installation medium (for example, USB) is | |
3a175eaa AZ |
63 | enabled in your server's firmware settings. Secure boot needs to be disabled |
64 | when booting an installer prior to {pve} version 8.1. | |
2c6fed66 | 65 | |
1ff5e4e8 | 66 | [thumbnail="screenshot/pve-grub-menu.png"] |
2d99ce9b | 67 | |
32caab0e AL |
68 | After choosing the correct entry (e.g. Boot from USB) the {pve} menu will be |
69 | displayed and one of the following options can be selected: | |
d91f8c1e | 70 | |
0c6bf9f5 | 71 | Install {pve} (Graphical):: |
d91f8c1e | 72 | |
32caab0e | 73 | Starts the normal installation. |
d91f8c1e | 74 | |
32caab0e AL |
75 | TIP: It's possible to use the installation wizard with a keyboard only. Buttons |
76 | can be clicked by pressing the `ALT` key combined with the underlined character | |
77 | from the respective button. For example, `ALT + N` to press a `Next` button. | |
1a5554fc | 78 | |
6452603e | 79 | Install {pve} (Terminal UI):: |
0c6bf9f5 CH |
80 | |
81 | Starts the console-mode installation wizard. It provides the same overall | |
82 | installation experience as the graphical installer, but has generally better | |
83 | compatibility with very old and very new hardware. | |
84 | ||
8668bfdf | 85 | [thumbnail="screenshot/pve-tui-installer.png"] |
38df5426 | 86 | |
8668bfdf TL |
87 | Both modes use the same code base for the actual installation process to |
88 | benefit from more than a decade of bug fixes and ensure feature parity. | |
89 | ||
6452603e | 90 | TIP: The 'Terminal UI' option can be used in case the graphical installer does |
8668bfdf | 91 | not work correctly, due to e.g. driver issues. |
0c6bf9f5 | 92 | |
6452603e | 93 | Advanced Options: Install {pve} (Graphical, Debug Mode):: |
d91f8c1e | 94 | |
32caab0e AL |
95 | Starts the installation in debug mode. A console will be opened at several |
96 | installation steps. This helps to debug the situation if something goes wrong. | |
8dc994f7 TL |
97 | To exit a debug console, press `CTRL-D`. This option can be used to boot a live |
98 | system with all basic tools available. You can use it, for example, to | |
99 | xref:chapter_zfs[repair a degraded ZFS 'rpool'] or fix the | |
100 | xref:sysboot[bootloader] for an existing {pve} setup. | |
d91f8c1e | 101 | |
6452603e | 102 | Advanced Options: Install {pve} (Terminal UI, Debug Mode):: |
0c6bf9f5 CH |
103 | |
104 | Same as the graphical debug mode, but preparing the system to run the | |
6452603e | 105 | terminal-based installer instead. |
0c6bf9f5 | 106 | |
6452603e | 107 | Advanced Options: Install {pve} (Serial Console Debug Mode):: |
0c6bf9f5 | 108 | |
6452603e CH |
109 | Same the terminal-based debug mode, but additionally sets up the Linux kernel to |
110 | use the (first) serial port of the machine for in- and output. | |
0c6bf9f5 | 111 | |
7e5ca633 | 112 | Advanced Options: Rescue Boot:: |
d91f8c1e | 113 | |
32caab0e AL |
114 | With this option you can boot an existing installation. It searches all attached |
115 | hard disks. If it finds an existing installation, it boots directly into that | |
116 | disk using the Linux kernel from the ISO. This can be useful if there are | |
7c73a209 CH |
117 | problems with the bootloader (GRUB/`systemd-boot`) or the BIOS/UEFI is unable to |
118 | read the boot block from the disk. | |
d91f8c1e | 119 | |
0c6bf9f5 | 120 | Advanced Options: Test Memory (memtest86+):: |
d91f8c1e | 121 | |
32caab0e | 122 | Runs `memtest86+`. This is useful to check if the memory is functional and free |
b0e1acde CH |
123 | of errors. Secure Boot must be turned off in the UEFI firmware setup utility to |
124 | run this option. | |
d91f8c1e | 125 | |
1ff5e4e8 | 126 | [thumbnail="screenshot/pve-select-target-disk.png"] |
2d99ce9b | 127 | |
32caab0e AL |
128 | After selecting *Install {pve}* and accepting the EULA, the prompt to select the |
129 | target hard disk(s) will appear. The `Options` button opens the dialog to select | |
130 | the target file system. | |
d91f8c1e | 131 | |
32caab0e | 132 | The default file system is `ext4`. The Logical Volume Manager (LVM) is used when |
60ed554f DW |
133 | `ext4` or `xfs` is selected. Additional options to restrict LVM space |
134 | can also be set (see <<advanced_lvm_options,below>>). | |
32caab0e AL |
135 | |
136 | {pve} can be installed on ZFS. As ZFS offers several software RAID levels, this | |
137 | is an option for systems that don't have a hardware RAID controller. The target | |
138 | disks must be selected in the `Options` dialog. More ZFS specific settings can | |
139 | be changed under `Advanced Options` (see <<advanced_zfs_options,below>>). | |
140 | ||
141 | WARNING: ZFS on top of any hardware RAID is not supported and can result in data | |
142 | loss. | |
d91f8c1e | 143 | |
1ff5e4e8 | 144 | [thumbnail="screenshot/pve-select-location.png", float="left"] |
2d99ce9b | 145 | |
32caab0e AL |
146 | The next page asks for basic configuration options like the location, the time |
147 | zone, and keyboard layout. The location is used to select a download server | |
148 | close by to speed up updates. The installer usually auto-detects these settings. | |
149 | They only need to be changed in the rare case that auto detection fails or a | |
150 | different keyboard layout should be used. | |
2d99ce9b | 151 | |
1ff5e4e8 | 152 | [thumbnail="screenshot/pve-set-password.png"] |
2d99ce9b | 153 | |
32caab0e AL |
154 | Next the password of the superuser (root) and an email address needs to be |
155 | specified. The password must consist of at least 5 characters. It's highly | |
156 | recommended to use a stronger password. Some guidelines are: | |
2d99ce9b DM |
157 | |
158 | - Use a minimum password length of 12 to 14 characters. | |
159 | ||
32caab0e | 160 | - Include lowercase and uppercase alphabetic characters, numbers, and symbols. |
2d99ce9b | 161 | |
32caab0e AL |
162 | - Avoid character repetition, keyboard patterns, common dictionary words, |
163 | letter or number sequences, usernames, relative or pet names, romantic links | |
164 | (current or past), and biographical information (for example ID numbers, | |
165 | ancestors' names or dates). | |
2d99ce9b | 166 | |
32caab0e AL |
167 | The email address is used to send notifications to the system administrator. |
168 | For example: | |
2d99ce9b DM |
169 | |
170 | - Information about available package updates. | |
171 | ||
172 | - Error messages from periodic CRON jobs. | |
173 | ||
7df6cb98 TL |
174 | [thumbnail="screenshot/pve-setup-network.png"] |
175 | ||
ac46aa04 MS |
176 | The last step is the network configuration. Network interfaces that are UP show |
177 | a filled circle in front of their name in the drop down menu. Please note that | |
178 | during installation you can either use an IPv4 or IPv6 address, but not both. To | |
179 | configure a dual stack node, add additional IP addresses after the installation. | |
d91f8c1e | 180 | |
1ff5e4e8 | 181 | [thumbnail="screenshot/pve-installation.png", float="left"] |
2d99ce9b | 182 | |
32caab0e AL |
183 | The next step shows a summary of the previously selected options. Re-check every |
184 | setting and use the `Previous` button if a setting needs to be changed. To | |
185 | accept, press `Install`. The installation starts to format disks and copies | |
186 | packages to the target. Please wait until this step has finished; then remove | |
187 | the installation medium and restart your system. | |
d91f8c1e | 188 | |
7df6cb98 TL |
189 | [thumbnail="screenshot/pve-install-summary.png"] |
190 | ||
b9a97ca1 MH |
191 | If the installation failed, check out specific errors on the second TTY |
192 | (`CTRL + ALT + F2') and ensure that the systems meets the | |
7df6cb98 | 193 | xref:install_minimal_requirements[minimum requirements]. If the installation |
b9a97ca1 | 194 | is still not working, look at the xref:getting_help[how to get help chapter]. |
7df6cb98 | 195 | |
32caab0e AL |
196 | Further configuration is done via the Proxmox web interface. Point your browser |
197 | to the IP address given during installation (https://youripaddress:8006). | |
fe6c04d5 | 198 | |
b9a97ca1 | 199 | NOTE: Default login is "root" (realm 'PAM') and the root password was defined |
32caab0e | 200 | during the installation process. |
d91f8c1e DM |
201 | |
202 | [[advanced_lvm_options]] | |
5eba0743 | 203 | Advanced LVM Configuration Options |
6b5fc47b | 204 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
d91f8c1e | 205 | |
32caab0e AL |
206 | The installer creates a Volume Group (VG) called `pve`, and additional Logical |
207 | Volumes (LVs) called `root`, `data`, and `swap`. To control the size of these | |
208 | volumes use: | |
d91f8c1e DM |
209 | |
210 | `hdsize`:: | |
211 | ||
32caab0e AL |
212 | Defines the total hard disk size to be used. This way you can reserve free space |
213 | on the hard disk for further partitioning (for example for an additional PV and | |
214 | VG on the same hard disk that can be used for LVM storage). | |
d91f8c1e DM |
215 | |
216 | `swapsize`:: | |
217 | ||
d3e2455a AL |
218 | Defines the size of the `swap` volume. The default is the size of the installed |
219 | memory, minimum 4 GB and maximum 8 GB. The resulting value cannot be greater | |
220 | than `hdsize/8`. | |
e8fe2b1b FG |
221 | + |
222 | NOTE: If set to `0`, no `swap` volume will be created. | |
d91f8c1e DM |
223 | |
224 | `maxroot`:: | |
225 | ||
fa281da6 TL |
226 | Defines the maximum size of the `root` volume, which stores the operation |
227 | system. The maximum limit of the `root` volume size is `hdsize/4`. | |
d91f8c1e DM |
228 | |
229 | `maxvz`:: | |
230 | ||
fa281da6 TL |
231 | Defines the maximum size of the `data` volume. The actual size of the `data` |
232 | volume is: | |
233 | + | |
234 | `datasize = hdsize - rootsize - swapsize - minfree` | |
235 | + | |
236 | Where `datasize` cannot be bigger than `maxvz`. | |
e8fe2b1b | 237 | + |
32caab0e AL |
238 | NOTE: In case of LVM thin, the `data` pool will only be created if `datasize` is |
239 | bigger than 4GB. | |
e8fe2b1b FG |
240 | + |
241 | NOTE: If set to `0`, no `data` volume will be created and the storage | |
242 | configuration will be adapted accordingly. | |
d91f8c1e DM |
243 | |
244 | `minfree`:: | |
245 | ||
32caab0e AL |
246 | Defines the amount of free space left in the LVM volume group `pve`. With more |
247 | than 128GB storage available the default is 16GB, else `hdsize/8` will be used. | |
d91f8c1e | 248 | + |
32caab0e AL |
249 | NOTE: LVM requires free space in the VG for snapshot creation (not required for |
250 | lvmthin snapshots). | |
d91f8c1e | 251 | |
71280de0 SI |
252 | [[advanced_zfs_options]] |
253 | Advanced ZFS Configuration Options | |
254 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
32caab0e AL |
255 | The installer creates the ZFS pool `rpool`. No swap space is created but you can |
256 | reserve some unpartitioned space on the install disks for swap. You can also | |
5f318cc0 | 257 | create a swap zvol after the installation, although this can lead to problems. |
71280de0 SI |
258 | (see <<zfs_swap,ZFS swap notes>>). |
259 | ||
260 | `ashift`:: | |
261 | ||
32caab0e AL |
262 | Defines the `ashift` value for the created pool. The `ashift` needs to be set at |
263 | least to the sector-size of the underlying disks (2 to the power of `ashift` is | |
264 | the sector-size), or any disk which might be put in the pool (for example the | |
265 | replacement of a defective disk). | |
71280de0 SI |
266 | |
267 | `compress`:: | |
268 | ||
269 | Defines whether compression is enabled for `rpool`. | |
270 | ||
271 | `checksum`:: | |
272 | ||
273 | Defines which checksumming algorithm should be used for `rpool`. | |
274 | ||
275 | `copies`:: | |
276 | ||
277 | Defines the `copies` parameter for `rpool`. Check the `zfs(8)` manpage for the | |
278 | semantics, and why this does not replace redundancy on disk-level. | |
279 | ||
280 | `hdsize`:: | |
281 | ||
32caab0e | 282 | Defines the total hard disk size to be used. This is useful to save free space |
5f318cc0 | 283 | on the hard disk(s) for further partitioning (for example to create a |
32caab0e AL |
284 | swap-partition). `hdsize` is only honored for bootable disks, that is only the |
285 | first disk or mirror for RAID0, RAID1 or RAID10, and all disks in RAID-Z[123]. | |
71280de0 | 286 | |
d91f8c1e DM |
287 | |
288 | ZFS Performance Tips | |
6b5fc47b | 289 | ~~~~~~~~~~~~~~~~~~~~ |
d91f8c1e | 290 | |
32caab0e AL |
291 | ZFS works best with a lot of memory. If you intend to use ZFS make sure to have |
292 | enough RAM available for it. A good calculation is 4GB plus 1GB RAM for each TB | |
cdf58596 | 293 | RAW disk space. |
d91f8c1e | 294 | |
32caab0e AL |
295 | ZFS can use a dedicated drive as write cache, called the ZFS Intent Log (ZIL). |
296 | Use a fast drive (SSD) for it. It can be added after installation with the | |
297 | following command: | |
d91f8c1e | 298 | |
32caab0e AL |
299 | ---- |
300 | # zpool add <pool-name> log </dev/path_to_fast_ssd> | |
301 | ---- | |
078924cd | 302 | |
83a43f6e CH |
303 | Adding the `nomodeset` Kernel Parameter |
304 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
305 | ||
306 | Problems may arise on very old or very new hardware due to graphics drivers. If | |
307 | the installation hangs during the boot. In that case, you can try adding the | |
308 | `nomodeset` parameter. This prevents the Linux kernel from loading any | |
309 | graphics drivers and forces it to continue using the BIOS/UEFI-provided | |
310 | framebuffer. | |
311 | ||
312 | On the {pve} bootloader menu, navigate to 'Install {pve} (Terminal UI)' and | |
313 | press `e` to edit the entry. Using the arrow keys, navigate to the line starting | |
314 | with `linux`, move the cursor to the end of that line and add the | |
315 | parameter `nomodeset`, separated by a space from the pre-existing last | |
316 | parameter. | |
317 | ||
318 | Then press `Ctrl-X` or `F10` to boot the configuration. | |
319 | ||
078924cd DM |
320 | ifndef::wiki[] |
321 | ||
322 | Install {pve} on Debian | |
6b5fc47b | 323 | ----------------------- |
078924cd | 324 | |
b9a97ca1 | 325 | {pve} ships as a set of Debian packages and can be installed on top of a standard |
32caab0e AL |
326 | Debian installation. |
327 | xref:sysadmin_package_repositories[After configuring the repositories] you need | |
328 | to run the following commands: | |
078924cd | 329 | |
078924cd | 330 | ---- |
32caab0e AL |
331 | # apt-get update |
332 | # apt-get install proxmox-ve | |
078924cd DM |
333 | ---- |
334 | ||
32caab0e AL |
335 | Installing on top of an existing Debian installation looks easy, but it presumes |
336 | that the base system has been installed correctly and that you know how you want | |
337 | to configure and use the local storage. You also need to configure the network | |
338 | manually. | |
115aef16 | 339 | |
32caab0e | 340 | In general, this is not trivial, especially when LVM or ZFS is used. |
115aef16 | 341 | |
32caab0e | 342 | A detailed step by step how-to can be found on the |
def3e106 | 343 | {webwiki-url}Install_Proxmox_VE_on_Debian_12_Bookworm[wiki]. |
078924cd | 344 | |
078924cd | 345 | |
5c6cf7ac | 346 | endif::wiki[] |
078924cd | 347 | |
078924cd DM |
348 | ifdef::wiki[] |
349 | ||
350 | Video Tutorials | |
6b5fc47b | 351 | --------------- |
078924cd | 352 | |
e941eafc TL |
353 | See the list of all official tutorials on our |
354 | https://www.youtube.com/proxmoxve[{pve} YouTube Channel] | |
078924cd DM |
355 | |
356 | ||
357 | See Also | |
6b5fc47b | 358 | -------- |
078924cd | 359 | |
3b5f76b8 DJ |
360 | * link:/wiki/Prepare_Installation_Media[Prepare Installation Media] |
361 | ||
362 | * link:/wiki/Install_Proxmox_VE_on_Debian_Buster[Install Proxmox VE on Debian Buster] | |
363 | ||
bc1c71d4 DM |
364 | * link:/wiki/System_Requirements[System Requirements] |
365 | ||
078924cd DM |
366 | * link:/wiki/Package_Repositories[Package Repositories] |
367 | ||
368 | * link:/wiki/Host_System_Administration[Host System Administration] | |
369 | ||
370 | * link:/wiki/Network_Configuration[Network Configuration] | |
371 | ||
e723066c DM |
372 | * link:/wiki/Installation:_Tips_and_Tricks[Installation: Tips and Tricks] |
373 | ||
078924cd | 374 | endif::wiki[] |