Signed-off-by: fritz <f.ramberger@proxmox.com>
[pve-docs.git] / pve-installation.adoc
1 Installing Proxmox VE
2 =====================
3 include::attributes.txt[]
4 ifndef::manvolnum[]
5 :pve-toplevel:
6 endif::manvolnum[]
7 ifdef::wiki[]
8 :title: Installation
9 endif::wiki[]
10
11 {pve} is based on Debian and comes with an installation CD-ROM 
12 which includes a complete Debian ("jessie" for Proxmox VE 4.x) system as 
13 well as all necessary Proxmox VE packages. The
14 installer just asks you a few questions, then partitions the local
15 disk(s), installs all required packages, and configures the system
16 including a basic network setup. You can get a fully functional system
17 within a few minutes. This is the preferred and recommended installation method.
18
19 Alternatively, Proxmox VE can be installed on top of an existing Debian system. 
20 This option is only recommended for advanced users since detail knowledge about 
21 Proxmox VE is necessary.
22
23 ifndef::wiki[]
24
25 include::pve-system-requirements.adoc[]
26
27 endif::wiki[]
28
29
30 Using the {pve} Installation CD-ROM
31 -----------------------------------
32
33 Includes the following:
34
35 * Complete operating system (Debian Linux, 64-bit)
36 * Partition the hard drive with ext4 (alternative ext3 or xfs) or ZFS
37 * {pve} Kernel with LXC and KVM support
38 * Complete toolset
39 * Web based management interface
40
41
42 NOTE: By default, the complete server is used and all existing data is
43 removed.
44
45 Please insert the installation CD-ROM, then boot from that
46 drive. Immediately afterwards you can choose the following menu
47 options:
48
49 Install Proxmox VE::
50
51 Start normal installation.
52
53 Install Proxmox VE (Debug mode)::
54
55 Start installation in debug mode. It opens a shell console at several
56 installation steps, so that you can debug things if something goes
57 wrong. Please press `CTRL-D` to exit those debug consoles and continue
58 installation. This option is mostly for developers and not meant for
59 general use.
60
61 Rescue Boot::
62
63 This option allows you to boot an existing installation. It searches
64 all attached hard disks and, if it finds an existing installation,
65 boots directly into that disk using the existing Linux kernel. This
66 can be useful if there are problems with the boot block (grub), or the
67 BIOS is unable to read the boot block from the disk.
68
69 Test Memory::
70
71 Runs `memtest86+`. This is useful to check if your memory is
72 functional and error free.
73
74 You normally select *Install Proxmox VE* to start the installation.
75 After that you get prompted to select the target hard disk(s). The
76 `Options` button lets you select the target file system, which
77 defaults to `ext4`. The installer uses LVM if you select `ext3`,
78 `ext4` or `xfs` as file system, and offers additional option to
79 restrict LVM space (see <<advanced_lvm_options,below>>)
80
81 If you have more than one disk, you can also use ZFS as file system.
82 ZFS supports several software RAID levels, so this is specially useful
83 if you do not have a hardware RAID controller. The `Options` button
84 lets you select the ZFS RAID level, and you can choose disks there.
85
86 The next pages just ask for basic configuration options like time
87 zone and keyboard layout. You also need to specify your email address
88 and superuser (root) password (must have at least 5 characters).
89
90 The last step is the network configuration. Please note that you can
91 use either IPv4 or IPv6 here, but not both. If you want to configure a
92 dual stack node, you can easily do that after installation.
93
94 If you press `Next` now, installation starts to format disks, and
95 copies packages to the target. Please wait until that is finished,
96 then reboot the server.
97
98 Further configuration is done via the Proxmox web interface. Just
99 point your browser to the IP address given during installation
100 (https://youripaddress:8006).
101
102 NOTE: Default login is "root" (realm 'PAM') and the root password is
103 defined during the installation process.
104
105
106 [[advanced_lvm_options]]
107 Advanced LVM Configuration Options
108 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
109
110 The installer creates a Volume Group (VG) called `pve`, and additional
111 Logical Volumes (LVs) called `root`, `data` and `swap`. The size of
112 those volumes can be controlled with:
113
114 `hdsize`::
115
116 Defines the total HD size to be used. This way you can save free
117 space on the HD for further partitioning (i.e. for an additional PV
118 and VG on the same hard disk that can be used for LVM storage).
119
120 `swapsize`::
121
122 To define the size of the `swap` volume. Default is the same size as
123 installed RAM, with 4GB minimum and `hdsize/8` as maximum.
124
125 `maxroot`::
126
127 The `root` volume size. The `root` volume stores the whole operation
128 system.
129
130 `maxvz`::
131
132 Define the size of the `data` volume.
133
134 `minfree`::
135
136 To define the amount of free space left in LVM volume group `pve`.
137 16GB is the default if storage available > 128GB, `hdsize/8` otherwise.
138 +
139 NOTE: LVM requires free space in the VG for snapshot creation (not
140 required for lvmthin snapshots).
141
142
143 ZFS Performance Tips
144 ~~~~~~~~~~~~~~~~~~~~
145
146 ZFS uses a lot of memory, so it is best to add additional RAM if you
147 want to use ZFS. A good calculation is 4GB plus 1GB RAM for each TB
148 RAW disk space.
149
150 ZFS also provides the feature to use a fast SSD drive as write cache. The
151 write cache is called the ZFS Intent Log (ZIL). You can add that after
152 installation using the following command:
153
154  zpool add <pool-name> log </dev/path_to_fast_ssd>
155
156
157 ifdef::wiki[]
158
159 link:/wiki/Install_Proxmox_VE_on_Debian_Jessie[Install Proxmox VE on Debian Jessie]
160 -----------------------------------------------------------------------------------
161
162 link:/wiki/Install_from_USB_Stick[Install from USB Stick]
163 ---------------------------------------------------------
164
165 endif::wiki[]
166
167 ifndef::wiki[]
168
169 Install {pve} on Debian
170 -----------------------
171
172 {pve} ships as a set of Debian packages, so you can install it
173 on top of a normal Debian installation. After configuring the
174 repositories, you need to run:
175
176 [source,bash]
177 ----
178 apt-get update
179 apt-get install proxmox-ve
180 ----
181
182 Installing on top of an existing Debian installation looks easy, but
183 it presumes that you have correctly installed the base system, and you
184 know how you want to configure and use the local storage. Network
185 configuration is also completely up to you.
186
187 In general, this is not trivial, especially when you use LVM or
188 ZFS.
189
190 You can find a detailed step by step howto on the
191 {webwiki-url}Install_Proxmox_VE_on_Debian_Jessie[wiki].
192
193 include::pve-usbstick.adoc[]
194
195 endif::wiki[]
196
197 ifdef::wiki[]
198
199 Video Tutorials
200 ---------------
201
202 * List of all official tutorials on our
203   http://www.youtube.com/proxmoxve[Proxmox VE YouTube Channel]
204
205 * Tutorials in Spanish language on
206   http://www.youtube.com/playlist?list=PLUULBIhA5QDBdNf1pcTZ5UXhek63Fij8z[ITexperts.es
207   YouTube Play List]
208
209
210 See Also
211 --------
212
213 * link:/wiki/System_Requirements[System Requirements]
214
215 * link:/wiki/Package_Repositories[Package Repositories]
216
217 * link:/wiki/Host_System_Administration[Host System Administration]
218
219 * link:/wiki/Network_Configuration[Network Configuration]
220
221 * link:/wiki/Installation:_Tips_and_Tricks[Installation: Tips and Tricks]
222
223 endif::wiki[]