]> git.proxmox.com Git - pve-docs.git/blobdiff - pve-installation.adoc
totp: fix copy/paste mistake
[pve-docs.git] / pve-installation.adoc
index dff6a4afc0c6ca6be538c270ebaa3e622d7c05da..bbfef045743e6e709ac2244f9db3e27f5ab330d2 100644 (file)
@@ -9,14 +9,17 @@ ifdef::wiki[]
 endif::wiki[]
 
 {pve} is based on Debian. This is why the install disk images (ISO files)
-provided by Proxmox include a complete Debian system (Debian 10 Buster for
-{pve} version 6.x) as well as all necessary {pve} packages.
+provided by Proxmox include a complete Debian system as well as all necessary
+{pve} packages.
 
-The installer will guide through the setup, allowing you to partition the local
-disk(s), apply basic system configurations (for example, timezone, language,
-network) and install all required packages. This process should not take more
-than a few minutes. Installing with the provided ISO is the recommended method
-for new and existing users.
+TIP: See the xref:faq-support-table[support table in the FAQ] for the
+relationship between {pve} releases and Debian releases.
+
+The installer will guide you through the setup, allowing you to partition the
+local disk(s), apply basic system configurations (for example, timezone,
+language, network) and install all required packages. This process should not
+take more than a few minutes. Installing with the provided ISO is the
+recommended method for new and existing users.
 
 Alternatively, {pve} can be installed on top of an existing Debian system. This
 option is only recommended for advanced users because detailed knowledge about
@@ -39,8 +42,8 @@ The installer ISO image includes the following:
 
 * Complete operating system (Debian Linux, 64-bit)
 
-* The {pve} installer, which partitions the local disk(s) with ext4, xfs
-  or ZFS and installs the operating system.
+* The {pve} installer, which partitions the local disk(s) with ext4, XFS,
+  BTRFS (technology preview), or ZFS and installs the operating system
 
 * {pve} Linux kernel with KVM and LXC support
 
@@ -49,22 +52,23 @@ The installer ISO image includes the following:
 
 * Web-based management interface
 
-NOTE: All existing data on the for installation selected drives will be removed
-during the installation process. The installer does not add boot menu entries
-for other operating systems.
+NOTE: All existing data on the selected drives will be removed during the
+installation process. The installer does not add boot menu entries for other
+operating systems.
 
 Please insert the xref:installation_prepare_media[prepared installation media]
 (for example, USB flash drive or CD-ROM) and boot from it.
 
 TIP: Make sure that booting from the installation medium (for example, USB) is
-enabled in your servers firmware settings.
+enabled in your server's firmware settings. Secure boot needs to be disabled
+when booting an installer prior to {pve} version 8.1.
 
 [thumbnail="screenshot/pve-grub-menu.png"]
 
-After choosing the correct entry (e.g. Boot from USB) the {pve} menu will be
-displayed and one of the following options can be selected:
+After choosing the correct entry (for example, 'Boot from USB') the {pve} menu
+will be displayed, and one of the following options can be selected:
 
-Install {pve}::
+Install {pve} (Graphical)::
 
 Starts the normal installation.
 
@@ -72,7 +76,29 @@ TIP: It's possible to use the installation wizard with a keyboard only. Buttons
 can be clicked by pressing the `ALT` key combined with the underlined character
 from the respective button. For example, `ALT + N` to press a `Next` button.
 
-Install {pve} (Debug mode)::
+Install {pve} (Terminal UI)::
+
+Starts the terminal-mode installation wizard. It provides the same overall
+installation experience as the graphical installer, but has generally better
+compatibility with very old and very new hardware.
+
+Install {pve} (Terminal UI, Serial Console)::
+
+Starts the terminal-mode installation wizard, additionally setting up the Linux
+kernel to use the (first) serial port of the machine for in- and output. This
+can be used if the machine is completely headless and only has a serial console
+available.
+
+[thumbnail="screenshot/pve-tui-installer.png"]
+
+Both modes use the same code base for the actual installation process to
+benefit from more than a decade of bug fixes and ensure feature parity.
+
+TIP: The 'Terminal UI' option can be used in case the graphical installer does
+not work correctly, due to e.g. driver issues. See also
+xref:nomodeset_kernel_param[adding the `nomodeset` kernel parameter].
+
+Advanced Options: Install {pve} (Graphical, Debug Mode)::
 
 Starts the installation in debug mode. A console will be opened at several
 installation steps. This helps to debug the situation if something goes wrong.
@@ -81,52 +107,70 @@ system with all basic tools available. You can use it, for example, to
 xref:chapter_zfs[repair a degraded ZFS 'rpool'] or fix the
 xref:sysboot[bootloader] for an existing {pve} setup.
 
-Rescue Boot::
+Advanced Options: Install {pve} (Terminal UI, Debug Mode)::
+
+Same as the graphical debug mode, but preparing the system to run the
+terminal-based installer instead.
+
+Advanced Options: Install {pve} (Serial Console Debug Mode)::
+
+Same the terminal-based debug mode, but additionally sets up the Linux kernel to
+use the (first) serial port of the machine for in- and output.
+
+Advanced Options: Rescue Boot::
 
 With this option you can boot an existing installation. It searches all attached
 hard disks. If it finds an existing installation, it boots directly into that
 disk using the Linux kernel from the ISO. This can be useful if there are
-problems with the boot block (grub) or the BIOS is unable to read the boot block
-from the disk.
+problems with the bootloader (GRUB/`systemd-boot`) or the BIOS/UEFI is unable to
+read the boot block from the disk.
 
-Test Memory::
+Advanced Options: Test Memory (memtest86+)::
 
 Runs `memtest86+`. This is useful to check if the memory is functional and free
-of errors.
+of errors. Secure Boot must be turned off in the UEFI firmware setup utility to
+run this option.
+
+You normally select *Install {pve} (Graphical)* to start the installation.
 
 [thumbnail="screenshot/pve-select-target-disk.png"]
 
-After selecting *Install {pve}* and accepting the EULA, the prompt to select the
-target hard disk(s) will appear. The `Options` button opens the dialog to select
-the target file system.
+The first step is to read our EULA (End User License Agreement). Following this,
+you can select the target hard disk(s) for the installation.
 
-The default file system is `ext4`. The Logical Volume Manager (LVM) is used when
-`ext4` or `xfs` is selected. Additional options to restrict LVM space
-can also be set (see <<advanced_lvm_options,below>>).
+CAUTION: By default, the whole server is used and all existing data is removed.
+Make sure there is no important data on the server before proceeding with the
+installation.
 
-{pve} can be installed on ZFS. As ZFS offers several software RAID levels, this
-is an option for systems that don't have a hardware RAID controller. The target
-disks must be selected in the `Options` dialog. More ZFS specific settings can
-be changed under `Advanced Options` (see <<advanced_zfs_options,below>>).
+The `Options` button lets you select the target file system, which
+defaults to `ext4`. The installer uses LVM if you select
+`ext4` or `xfs` as a file system, and offers additional options to
+restrict LVM space (see xref:advanced_lvm_options[below]).
+
+{pve} can also be installed on ZFS. As ZFS offers several software RAID levels,
+this is an option for systems that don't have a hardware RAID controller. The
+target disks must be selected in the `Options` dialog. More ZFS specific
+settings can be changed under xref:advanced_zfs_options[`Advanced Options`].
 
 WARNING: ZFS on top of any hardware RAID is not supported and can result in data
 loss.
 
-[thumbnail="screenshot/pve-select-location.png", float="left"]
+[thumbnail="screenshot/pve-select-location.png"]
 
-The next page asks for basic configuration options like the location, the time
-zone, and keyboard layout. The location is used to select a download server
-close by to speed up updates. The installer usually auto-detects these settings.
-They only need to be changed in the rare case that auto detection fails or a
-different keyboard layout should be used.
+The next page asks for basic configuration options like your location, time
+zone, and keyboard layout. The location is used to select a nearby download
+server, in order to increase the speed of updates. The installer is usually able
+to auto-detect these settings, so you only need to change them in rare
+situations when auto-detection fails, or when you want to use a keyboard layout
+not commonly used in your country.
 
-[thumbnail="screenshot/pve-set-password.png"]
+[thumbnail="screenshot/pve-set-password.png", float="left"]
 
-Next the password of the superuser (root) and an email address needs to be
+Next the password of the superuser (`root`) and an email address needs to be
 specified. The password must consist of at least 5 characters. It's highly
 recommended to use a stronger password. Some guidelines are:
 
-- Use a minimum password length of 12 to 14 characters.
+- Use a minimum password length of at least 12 characters.
 
 - Include lowercase and uppercase alphabetic characters, numbers, and symbols.
 
@@ -140,42 +184,77 @@ For example:
 
 - Information about available package updates.
 
-- Error messages from periodic CRON jobs.
+- Error messages from periodic 'cron' jobs.
 
 [thumbnail="screenshot/pve-setup-network.png"]
 
-The last step is the network configuration. Please note that during installation
-you can either use an IPv4 or IPv6 address, but not both. To configure a dual
-stack node, add additional IP addresses after the installation.
+All those notification mails will be sent to the specified email address.
+
+The last step is the network configuration. Network interfaces that are 'UP'
+show a filled circle in front of their name in the drop down menu. Please note
+that during installation you can either specify an IPv4 or IPv6 address, but not
+both. To configure a dual stack node, add additional IP addresses after the
+installation.
 
 [thumbnail="screenshot/pve-installation.png", float="left"]
 
-The next step shows a summary of the previously selected options. Re-check every
-setting and use the `Previous` button if a setting needs to be changed. To
-accept, press `Install`. The installation starts to format disks and copies
-packages to the target. Please wait until this step has finished; then remove
-the installation medium and restart your system.
+The next step shows a summary of the previously selected options. Please
+re-check every setting and use the `Previous` button if a setting needs to be
+changed.
+
+After clicking `Install`, the installer will begin to format the disks and copy
+packages to the target disk(s). Please wait until this step has finished; then
+remove the installation medium and restart your system.
 
 [thumbnail="screenshot/pve-install-summary.png"]
 
-If the installation failed check out specific errors on the second TTY
-(`CTRL + ALT + F2'), ensure that the systems meets the
-xref:install_minimal_requirements[minimum requirements]. If the installation
-is still not working look at the xref:getting_help[how to get help chapter].
+Copying the packages usually takes several minutes, mostly depending on the
+speed of the installation medium and the target disk performance.
+
+When copying and setting up the packages has finished, you can reboot the
+server. This will be done automatically after a few seconds by default.
+
+.Installation Failure
+
+If the installation failed, check out specific errors on the second TTY
+('CTRL + ALT + F2') and ensure that the systems meets the
+xref:install_minimal_requirements[minimum requirements].
+
+If the installation is still not working, look at the
+xref:getting_help[how to get help chapter].
 
-Further configuration is done via the Proxmox web interface. Point your browser
-to the IP address given during installation (https://youripaddress:8006).
 
-NOTE: Default login is "root" (realm 'PAM') and the root password is defined
-during the installation process.
+Accessing the Management Interface Post-Installation
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+[thumbnail="screenshot/gui-login-window.png"]
+
+After a succesful installation and reboot of the system you can use the {pve}
+web interface for further configuration.
+
+. Point your browser to the IP address given during the installation and port
+  8006, for example: https://youripaddress:8006
+
+. Log in using the `root` (realm 'PAM') username and the password chosen during
+  installation.
+
+. Upload your subscription key to gain access to the Enterprise repository.
+  Otherwise, you will need to set up one of the public, less tested package
+  repositories to get updates for security fixes, bug fixes, and new features.
+
+. Check the IP configuration and hostname.
+
+. Check the timezone.
+
+. Check your xref:chapter_pve_firewall[Firewall settings].
 
 [[advanced_lvm_options]]
 Advanced LVM Configuration Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
 The installer creates a Volume Group (VG) called `pve`, and additional Logical
-Volumes (LVs) called `root`, `data`, and `swap`. To control the size of these
-volumes use:
+Volumes (LVs) called `root`, `data`, and `swap`, if `ext4` or `xfs` is used. To
+control the size of these volumes use:
 
 `hdsize`::
 
@@ -213,8 +292,9 @@ configuration will be adapted accordingly.
 
 `minfree`::
 
-Defines the amount of free space left in the LVM volume group `pve`. With more
-than 128GB storage available the default is 16GB, else `hdsize/8` will be used.
+Defines the amount of free space that should be left in the LVM volume group
+`pve`. With more than 128GB storage available, the default is 16GB, otherwise
+`hdsize/8` will be used.
 +
 NOTE: LVM requires free space in the VG for snapshot creation (not required for
 lvmthin snapshots).
@@ -222,10 +302,10 @@ lvmthin snapshots).
 [[advanced_zfs_options]]
 Advanced ZFS Configuration Options
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-The installer creates the ZFS pool `rpool`. No swap space is created but you can
-reserve some unpartitioned space on the install disks for swap. You can also
-create a swap zvol after the installation, although this can lead to problems.
-(see <<zfs_swap,ZFS swap notes>>).
+The installer creates the ZFS pool `rpool`, if ZFS is used. No swap space is
+created but you can reserve some unpartitioned space on the install disks for
+swap. You can also create a swap zvol after the installation, although this can
+lead to problems (see xref:zfs_swap[ZFS swap notes]).
 
 `ashift`::
 
@@ -247,6 +327,13 @@ Defines which checksumming algorithm should be used for `rpool`.
 Defines the `copies` parameter for `rpool`. Check the `zfs(8)` manpage for the
 semantics, and why this does not replace redundancy on disk-level.
 
+`ARC max size`::
+
+Defines the maximum size the ARC can grow to and thus limits the amount of
+memory ZFS will use. See also the section on
+xref:sysadmin_zfs_limit_memory_usage[how to limit ZFS memory usage] for more
+details.
+
 `hdsize`::
 
 Defines the total hard disk size to be used. This is useful to save free space
@@ -270,12 +357,47 @@ following command:
 # zpool add <pool-name> log </dev/path_to_fast_ssd>
 ----
 
+[[nomodeset_kernel_param]]
+Adding the `nomodeset` Kernel Parameter
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Problems may arise on very old or very new hardware due to graphics drivers. If
+the installation hangs during boot, you can try adding the `nomodeset`
+parameter. This prevents the Linux kernel from loading any graphics drivers and
+forces it to continue using the BIOS/UEFI-provided framebuffer.
+
+On the {pve} bootloader menu, navigate to 'Install {pve} (Terminal UI)' and
+press `e` to edit the entry. Using the arrow keys, navigate to the line starting
+with `linux`, move the cursor to the end of that line and add the
+parameter `nomodeset`, separated by a space from the pre-existing last
+parameter.
+
+Then press `Ctrl-X` or `F10` to boot the configuration.
+
+[[installation_unattended]]
+Unattended Installation
+-----------------------
+
+It is possible to install {pve} automatically in an unattended manner. This
+enables you to fully automate the setup process on bare-metal. Once the
+installation is complete and the host has booted up, automation tools like
+Ansible can be used to further configure the installation.
+
+The necessary options for the installer must be provided in an answer file. This
+file allows the use of filter rules to determine which disks and network cards
+should be used.
+
+To use the automated installation, it is first necessary to prepare an
+installation ISO.
+https://pve.proxmox.com/wiki/Automated_Installation[Visit our wiki] for more
+details and information on the unattended installation.
+
 ifndef::wiki[]
 
 Install {pve} on Debian
 -----------------------
 
-{pve} ships as a set of Debian packages and can be installed on to of a standard
+{pve} ships as a set of Debian packages and can be installed on top of a standard
 Debian installation.
 xref:sysadmin_package_repositories[After configuring the repositories] you need
 to run the following commands:
@@ -293,7 +415,7 @@ manually.
 In general, this is not trivial, especially when LVM or ZFS is used.
 
 A detailed step by step how-to can be found on the
-{webwiki-url}Install_Proxmox_VE_on_Debian_Buster[wiki].
+{webwiki-url}Install_Proxmox_VE_on_Debian_12_Bookworm[wiki].
 
 
 endif::wiki[]
@@ -303,12 +425,8 @@ ifdef::wiki[]
 Video Tutorials
 ---------------
 
-* List of all official tutorials on our
-  https://www.youtube.com/proxmoxve[{pve} YouTube Channel]
-
-* Tutorials in Spanish language on
-  https://www.youtube.com/playlist?list=PLUULBIhA5QDBdNf1pcTZ5UXhek63Fij8z[ITexperts.es
-  YouTube Play List]
+See the list of all official tutorials on our
+https://www.youtube.com/proxmoxve[{pve} YouTube Channel]
 
 
 See Also
@@ -316,7 +434,7 @@ See Also
 
 * link:/wiki/Prepare_Installation_Media[Prepare Installation Media]
 
-* link:/wiki/Install_Proxmox_VE_on_Debian_Buster[Install Proxmox VE on Debian Buster]
+* link:/wiki/Install_Proxmox_VE_on_Debian_12_Bookworm[Install Proxmox VE on Debian 12 Bookworm]
 
 * link:/wiki/System_Requirements[System Requirements]