]> git.proxmox.com Git - pve-docs.git/blobdiff - pve-installation.adoc
Fixed typo in Ceph Metadata Server documentation
[pve-docs.git] / pve-installation.adoc
index 75dd9874eb27d0cc52018e6ade83205ab6f9be17..775bb84d4f2c0f8bd30a184d502dfc1523b08cd1 100644 (file)
@@ -1,37 +1,55 @@
 Installing Proxmox VE
 =====================
-include::attributes.txt[]
+ifndef::manvolnum[]
+:pve-toplevel:
+endif::manvolnum[]
+ifdef::wiki[]
+:title: Installation
+endif::wiki[]
 
-{pve} ships as a set of Debian packages, so you can simply install it
-on top of a normal Debian installation, or download the installation
-CD-ROM and use that to install {pve} on your hardware.
+{pve} is based on Debian and comes with an installation CD-ROM
+which includes a complete Debian system ("stretch" for version 5.x) as
+well as all necessary {pve} packages.
 
-Installing on top of an existing Debian installation looks easy, but
-it presumes that you have correctly installed the base system, and you
-know how you want to configure and use the local storage. Network
-configuration is also completely up to you.
-
-In general, this is not trivial, especially when you use LVM or
-ZFS. This is why we provide an installation CD-ROM for {pve}. That
-installer just ask you a few questions, then partitions the local
-disk(s), installs all required packages and configures the system
+The installer just asks you a few questions, then partitions the local
+disk(s), installs all required packages, and configures the system
 including a basic network setup. You can get a fully functional system
-within a few minutes, including the following:
+within a few minutes. This is the preferred and recommended
+installation method.
 
-* Complete operating system (Debian Linux, 64-bit)
-* Partition the hard drive with ext4 (alternative ext3 or xfs) or ZFS
-* {pve} Kernel with LXC and KVM support
-* Complete toolset
-* Web based management interface
+Alternatively, {pve} can be installed on top of an existing Debian
+system. This option is only recommended for advanced users since
+detail knowledge about {pve} is necessary.
+
+ifndef::wiki[]
+
+include::pve-system-requirements.adoc[]
+
+endif::wiki[]
 
 
 Using the {pve} Installation CD-ROM
 -----------------------------------
 
-This is the preferred and recommended installation method.
+You can download the ISO from {website}en/downloads.
+It includes the following:
+
+* Complete operating system (Debian Linux, 64-bit)
+
+* The {pve} installer, which partitions the hard drive(s) with ext4,
+  ext3, xfs or ZFS and installs the operating system.
 
-NOTE: By default, the complete server is used and all existing data is
-removed.
+* {pve} kernel (Linux) with LXC and KVM support
+
+* Complete toolset for administering virtual machines, containers and
+  all necessary resources
+
+* Web based management interface for using the toolset
+
+NOTE: During the installation process, the complete server
+is used by default and all existing data is removed.
+
+[thumbnail="screenshot/pve-grub-menu.png"]
 
 Please insert the installation CD-ROM, then boot from that
 drive. Immediately afterwards you can choose the following menu
@@ -41,6 +59,11 @@ Install Proxmox VE::
 
 Start normal installation.
 
+TIP: It is possible to only use the keyboard to progress through the
+installation wizard. Buttons can be pressed by pressing down the `ALT`
+key, combined with the underlined character from the respective Button.
+For example, `ALT + N` to press a `Next` button.
+
 Install Proxmox VE (Debug mode)::
 
 Start installation in debug mode. It opens a shell console at several
@@ -62,6 +85,8 @@ Test Memory::
 Runs `memtest86+`. This is useful to check if your memory is
 functional and error free.
 
+[thumbnail="screenshot/pve-select-target-disk.png"]
+
 You normally select *Install Proxmox VE* to start the installation.
 After that you get prompted to select the target hard disk(s). The
 `Options` button lets you select the target file system, which
@@ -69,27 +94,61 @@ defaults to `ext4`. The installer uses LVM if you select `ext3`,
 `ext4` or `xfs` as file system, and offers additional option to
 restrict LVM space (see <<advanced_lvm_options,below>>)
 
-If you have more than one disk, you can also use ZFS as file system.
-ZFS supports several software RAID levels, so this is specially useful
-if you do not have a hardware RAID controller. The `Options` button
-lets you select the ZFS RAID level, and you can choose disks there.
+You can also use ZFS as file system. ZFS supports several software RAID
+levels, so this is specially useful if you do not have a hardware RAID
+controller. The `Options` button lets you select the ZFS RAID level, and
+you can choose disks there. Additionally you can set additional options (see
+<<advanced_zfs_options,below>>).
+
+[thumbnail="screenshot/pve-select-location.png", float="left"]
+
+The next page just ask for basic configuration options like your
+location, the time zone and keyboard layout. The location is used to
+select a download server near you to speedup updates. The installer is
+usually able to auto detect those setting, so you only need to change
+them in rare situations when auto detection fails, or when you want to
+use some special keyboard layout not commonly used in your country.
+
+[thumbnail="screenshot/pve-set-password.png"]
+
+You then need to specify an email address and the superuser (root)
+password. The password must have at least 5 characters, but we highly
+recommend to use stronger passwords - here are some guidelines:
+
+- Use a minimum password length of 12 to 14 characters.
+
+- Include lowercase and uppercase alphabetic characters, numbers and symbols.
+
+- Avoid character repetition, keyboard patterns, dictionary words,
+  letter or number sequences, usernames, relative or pet names,
+  romantic links (current or past) and biographical information (e.g.,
+  ID numbers, ancestors' names or dates).
+
+It is sometimes necessary to send notification to the system
+administrator, for example:
+
+- Information about available package updates.
+
+- Error messages from periodic CRON jobs.
 
-The next pages just ask for basic configuration options like time
-zone and keyboard layout. You also need to specify your email address
-and superuser (root) password (must have at least 5 characters).
+All those notification mails will be sent to the specified email
+address.
+
+[thumbnail="screenshot/pve-setup-network.png"]
 
 The last step is the network configuration. Please note that you can
 use either IPv4 or IPv6 here, but not both. If you want to configure a
 dual stack node, you can easily do that after installation.
 
+[thumbnail="screenshot/pve-installation.png", float="left"]
+
 If you press `Next` now, installation starts to format disks, and
 copies packages to the target. Please wait until that is finished,
 then reboot the server.
 
 Further configuration is done via the Proxmox web interface. Just
 point your browser to the IP address given during installation
-(https://youripaddress:8006). {pve} is tested for IE9, Firefox 10
-and higher, and Google Chrome.
+(https://youripaddress:8006).
 
 NOTE: Default login is "root" (realm 'PAM') and the root password is
 defined during the installation process.
@@ -111,26 +170,76 @@ and VG on the same hard disk that can be used for LVM storage).
 
 `swapsize`::
 
-To define the size of the `swap` volume. Default is the same size as
-installed RAM, with 4GB minimum and `hdsize/8` as maximum.
+Defines the size of the `swap` volume. The default is the size of the
+installed memory, minimum 4 GB and maximum 8 GB. The resulting value cannot
+be greater than `hdsize/8`.
++
+NOTE: If set to `0`, no `swap` volume will be created.
 
 `maxroot`::
 
-The `root` volume size. The `root` volume stores the whole operation
-system.
+Defines the maximum size of the `root` volume, which stores the operation
+system. The maximum limit of the `root` volume size is `hdsize/4`.
 
 `maxvz`::
 
-Define the size of the `data` volume.
+Defines the maximum size of the `data` volume. The actual size of the `data`
+volume is:
++
+`datasize = hdsize - rootsize - swapsize - minfree`
++
+Where `datasize` cannot be bigger than `maxvz`.
++
+NOTE: In case of LVM thin, the `data` pool will only be created if `datasize`
+is bigger than 4GB.
++
+NOTE: If set to `0`, no `data` volume will be created and the storage
+configuration will be adapted accordingly.
 
 `minfree`::
 
-To define the amount of free space left in LVM volume group `pve`.
-16GB is the default if storage available > 128GB, `hdsize/8` otherwise.
+Defines the amount of free space left in LVM volume group `pve`.
+With more than 128GB storage available the default is 16GB, else `hdsize/8`
+will be used.
 +
 NOTE: LVM requires free space in the VG for snapshot creation (not
 required for lvmthin snapshots).
 
+[[advanced_zfs_options]]
+Advanced ZFS Configuration Options
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+The installer creates a ZFS pool `rpool`. When selecting ZFS, no swap space is
+created by default. You can leave some unpartitioned space for swap or create
+a swap zvol after installation, though the latter can lead to problems
+(see <<zfs_swap,ZFS swap notes>>).
+
+`ashift`::
+
+Defines the `ashift` value for the created pool. The `ashift` needs
+to be set at least to the sector-size of the underlying disks (2 to
+the power of `ashift` is the sector-size), or any disk,
+which might be put in the pool (e.g. during replacing a defective disk).
+
+`compress`::
+
+Defines whether compression is enabled for `rpool`.
+
+`checksum`::
+
+Defines which checksumming algorithm should be used for `rpool`.
+
+`copies`::
+
+Defines the `copies` parameter for `rpool`. Check the `zfs(8)` manpage for the
+semantics, and why this does not replace redundancy on disk-level.
+
+`hdsize`::
+
+Defines the total HD size to be used. This way you can save free
+space on the HD(s) for further partitioning (e.g. for creating a swap-partition).
+`hdsize` is only honored for bootable disks, i.e., only the first disk or
+mirror for RAID0, RAID1 or RAID10, and all disks in RAID-Z[123].
+
 
 ZFS Performance Tips
 ~~~~~~~~~~~~~~~~~~~~
@@ -148,8 +257,11 @@ installation using the following command:
 
 ifdef::wiki[]
 
-link:/wiki/Install_Proxmox_VE_on_Debian_Jessie[Install Proxmox VE on Debian Jessie]
------------------------------------------------------------------------------------
+link:/wiki/Install_Proxmox_VE_on_Debian_Stretch[Install Proxmox VE on Debian Stretch]
+-------------------------------------------------------------------------------------
+
+link:/wiki/Install_from_USB_Stick[Install from USB Stick]
+---------------------------------------------------------
 
 endif::wiki[]
 
@@ -158,7 +270,7 @@ ifndef::wiki[]
 Install {pve} on Debian
 -----------------------
 
-{pve} ships as a set of Debian packages, so you can simply install it
+{pve} ships as a set of Debian packages, so you can install it
 on top of a normal Debian installation. After configuring the
 repositories, you need to run:
 
@@ -168,11 +280,20 @@ apt-get update
 apt-get install proxmox-ve
 ----
 
-You can find a detailed step by step howto on the
-{webwiki-url}Install_Proxmox_VE_on_Debian_Jessie[wiki].
+Installing on top of an existing Debian installation looks easy, but
+it presumes that you have correctly installed the base system, and you
+know how you want to configure and use the local storage. Network
+configuration is also completely up to you.
+
+In general, this is not trivial, especially when you use LVM or
+ZFS.
+
+You can find a detailed step by step how-to guide on the
+{webwiki-url}Install_Proxmox_VE_on_Debian_Stretch[wiki].
 
-endif::wiki[]
+include::pve-usbstick.adoc[]
 
+endif::wiki[]
 
 ifdef::wiki[]
 
@@ -190,6 +311,8 @@ Video Tutorials
 See Also
 --------
 
+* link:/wiki/System_Requirements[System Requirements]
+
 * link:/wiki/Package_Repositories[Package Repositories]
 
 * link:/wiki/Host_System_Administration[Host System Administration]