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