]>
Commit | Line | Data |
---|---|---|
4736f1bc | 1 | [[chapter_gui]] |
813e4036 DM |
2 | Graphical User Interface |
3 | ======================== | |
4736f1bc DM |
4 | ifndef::manvolnum[] |
5 | :pve-toplevel: | |
6 | endif::manvolnum[] | |
c5eadcbd | 7 | |
813e4036 | 8 | {pve} is simple. There is no need to install a separate management |
3b02e046 DM |
9 | tool, and everything can be done through your web browser (Latest |
10 | Firefox or Google Chrome is preferred). A built-in HTML5 console is | |
11 | used to access the guest console. As an alternative, | |
12 | https://www.spice-space.org/[SPICE] can be used. | |
c5eadcbd | 13 | |
3b02e046 DM |
14 | Because we use the Proxmox cluster file system (pmxcfs), you can |
15 | connect to any node to manage the entire cluster. Each node can manage | |
16 | the entire cluster. There is no need for a dedicated manager node. | |
c5eadcbd | 17 | |
3b02e046 DM |
18 | You can use the web-based administration interface with any modern |
19 | browser. When {pve} detects that you are connecting from a mobile | |
20 | device, you are redirected to a simpler, touch-based user interface. | |
c5eadcbd WL |
21 | |
22 | The web interface can be reached via https://youripaddress:8006 | |
3b02e046 DM |
23 | (default login is: 'root', and the password is specified during the |
24 | installation process). | |
c5eadcbd WL |
25 | |
26 | ||
813e4036 | 27 | Features |
4736f1bc | 28 | -------- |
c5eadcbd | 29 | |
3b02e046 DM |
30 | * Seamless integration and management of {pve} clusters |
31 | ||
c5eadcbd | 32 | * AJAX technologies for dynamic updates of resources |
3b02e046 DM |
33 | |
34 | * Secure access to all Virtual Machines and Containers via SSL | |
35 | encryption (https) | |
36 | ||
37 | * Fast search-driven interface, capable of handling hundreds and | |
38 | probably thousands of VMs | |
39 | ||
c5eadcbd | 40 | * Secure HTML5 console or SPICE |
3b02e046 DM |
41 | |
42 | * Role based permission management for all objects (VMs, storages, | |
43 | nodes, etc.) | |
44 | ||
45 | * Support for multiple authentication sources (e.g. local, MS ADS, | |
46 | LDAP, ...) | |
47 | ||
48 | * Two-Factor Authentication (OATH, Yubikey) | |
49 | ||
50 | * Based on ExtJS 6.x JavaScript framework | |
c5eadcbd WL |
51 | |
52 | ||
5948aa79 DM |
53 | Login |
54 | ----- | |
55 | ||
1ff5e4e8 | 56 | [thumbnail="screenshot/gui-login-window.png"] |
5948aa79 | 57 | |
470d4313 | 58 | When you connect to the server, you will first see the login window. |
5948aa79 | 59 | {pve} supports various authentication backends ('Realm'), and |
470d4313 | 60 | you can select the language here. The GUI is translated to more |
5948aa79 DM |
61 | than 20 languages. |
62 | ||
63 | NOTE: You can save the user name on the client side by selection the | |
64 | checkbox at the bottom. This saves some typing when you login next | |
65 | time. | |
66 | ||
67 | ||
813e4036 DM |
68 | GUI Overview |
69 | ------------ | |
c5eadcbd | 70 | |
1ff5e4e8 | 71 | [thumbnail="screenshot/gui-datacenter-summary.png"] |
c5eadcbd | 72 | |
5948aa79 DM |
73 | The {pve} user interface consists of four regions. |
74 | ||
75 | [horizontal] | |
76 | ||
77 | Header:: On top. Shows status information and contains buttons for | |
78 | most important actions. | |
79 | ||
80 | Resource Tree:: At the left side. A navigation tree where you can select | |
81 | specific objects. | |
82 | ||
83 | Content Panel:: Center region. Selected objects displays configuration | |
84 | options and status here. | |
85 | ||
86 | Log Panel:: At the bottom. Displays log entries for recent tasks. You | |
87 | can double-click on those log entries to get more details, or to abort | |
88 | a running task. | |
89 | ||
90 | NOTE: You can shrink and expand the size of the resource tree and log | |
91 | panel, or completely hide the log panel. This can be helpful when you | |
92 | work on small displays and want more space to view other content. | |
93 | ||
94 | ||
95 | Header | |
96 | ~~~~~~ | |
97 | ||
98 | On the top left side, the first thing you see is the Proxmox | |
99 | logo. Next to it is the current running version of {pve}. In the | |
100 | search bar nearside you can search for specific objects (VMs, | |
101 | containers, nodes, ...). This is sometimes faster than selecting an | |
102 | object in the resource tree. | |
98c2ef68 | 103 | |
5948aa79 DM |
104 | To the right of the search bar we see the identity (login name). The |
105 | gear symbol is a button opening the 'My Settings' dialog. There you | |
106 | can customize some client side user interface setting (reset the saved | |
107 | login name, reset saved layout). | |
108 | ||
109 | The rightmost part of the header contains four buttons: | |
110 | ||
111 | [horizontal] | |
470d4313 | 112 | Help :: Opens a new browser window showing the reference documentation. |
5948aa79 DM |
113 | |
114 | Create VM :: Opens the virtual machine creation wizard. | |
115 | ||
116 | Create CT :: Open the container creation wizard. | |
117 | ||
118 | Logout :: Logout, and show the login dialog again. | |
119 | ||
120 | ||
bf5de2d9 DL |
121 | [[gui_my_settings]] |
122 | My Settings | |
123 | ~~~~~~~~~~~ | |
124 | ||
125 | [thumbnail="screenshot/gui-my-settings.png"] | |
126 | ||
127 | The 'My Settings' window allows you to set locally stored settings. These | |
128 | include the 'Dashboard Storages' which allow you to enable or disable specific | |
129 | storages to be counted towards the total amount visible in the datacenter | |
130 | summary. If no storage is checked the total is the sum of all storages, same | |
131 | as enabling every single one. | |
132 | ||
133 | Below the dashboard settings you find the stored user name and a button to | |
134 | clear it as well as a button to reset every layout in the GUI to its default. | |
135 | ||
136 | On the right side there are 'xterm.js Settings'. These contain the following | |
137 | options: | |
138 | ||
139 | [horizontal] | |
140 | Font-Family :: The font to be used in xterm.js (e.g. Arial). | |
141 | ||
142 | Font-Size :: The preferred font size to be used. | |
143 | ||
144 | Letter Spacing :: Increases or decreases spacing between letters in text. | |
145 | ||
146 | Line Height :: Specify the absolute height of a line. | |
147 | ||
148 | ||
149 | ||
5948aa79 DM |
150 | Resource Tree |
151 | ~~~~~~~~~~~~~ | |
152 | ||
153 | This is the main navigation tree. On top of the tree you can select | |
154 | some predefined views, which changes the structure of the tree | |
155 | below. The default view is *Server View*, and it shows the following | |
156 | object types: | |
157 | ||
158 | [horizontal] | |
159 | Datacenter:: Contains cluster wide setting (relevant for all nodes). | |
160 | ||
161 | Node:: Represents the hosts inside a cluster, where the guests runs. | |
98c2ef68 | 162 | |
5948aa79 | 163 | Guest:: VMs, Containers and Templates. |
c5eadcbd | 164 | |
5948aa79 | 165 | Storage:: Data Storage. |
c5eadcbd | 166 | |
5948aa79 DM |
167 | Pool:: It is possible to group guests using a pool to simplify |
168 | management. | |
169 | ||
170 | ||
171 | The following view types are available: | |
172 | ||
173 | [horizontal] | |
174 | Server View:: Shows all kind of objects, grouped by nodes. | |
175 | ||
176 | Folder View:: Shows all kind of objects, grouped by object type. | |
177 | ||
178 | Storage View:: Only show storage objects, grouped by nodes. | |
179 | ||
180 | Pool View:: Show VMs and Containers, grouped by pool. | |
181 | ||
182 | ||
183 | Log Panel | |
184 | ~~~~~~~~~ | |
185 | ||
186 | The main purpose of the log panel is to show you what is currently | |
187 | going on in your cluster. Actions like creating an new VM are executed | |
188 | in background, and we call such background job a 'task'. | |
189 | ||
190 | Any output from such task is saved into a separate log file. You can | |
191 | view that log by simply double-click a task log entry. It is also | |
192 | possible to abort a running task there. | |
193 | ||
194 | Please note that we display most recent tasks from all cluster nodes | |
195 | here. So you can see when somebody else is working on another cluster | |
196 | node in real-time. | |
197 | ||
198 | NOTE: We remove older and finished task from the log panel to keep | |
199 | that list short. But you can still find those tasks in the 'Task | |
200 | History' within the node panel. | |
201 | ||
202 | Some short running actions simply sends logs to all cluster | |
203 | members. You can see those messages in the 'Cluster log' panel. | |
204 | ||
205 | ||
206 | Content Panels | |
207 | -------------- | |
208 | ||
bc22b69b | 209 | When you select something in the resource tree, the corresponding |
5948aa79 | 210 | object displays configuration and status information in the content |
bc22b69b | 211 | panel. The following sections give a brief overview of the |
5948aa79 | 212 | functionality. Please refer to the individual chapters inside the |
470d4313 | 213 | reference documentation to get more detailed information. |
5948aa79 DM |
214 | |
215 | ||
216 | Datacenter | |
217 | ~~~~~~~~~~ | |
1a497fa7 | 218 | |
1ff5e4e8 | 219 | [thumbnail="screenshot/gui-datacenter-search.png"] |
f9c4114c | 220 | |
6db8976c | 221 | On the datacenter level you can access cluster wide settings and information. |
1a497fa7 WL |
222 | |
223 | * *Search:* it is possible to search anything in cluster | |
224 | ,this can be a node, VM, Container, Storage or a pool. | |
225 | ||
7ec90af3 | 226 | * *Summary:* gives a brief overview over the cluster health. |
1a497fa7 | 227 | |
5fd107e5 OB |
228 | * *Cluster:* allows to create/join cluster and shows join information. |
229 | ||
1a497fa7 WL |
230 | * *Options:* can show and set defaults, which apply cluster wide. |
231 | ||
232 | * *Storage:* is the place where a storage will add/managed/removed. | |
233 | ||
234 | * *Backup:* has the capability to schedule Backups. This is | |
235 | cluster wide, so you do not care about where the VM/Container are on | |
236 | your cluster at schedule time. | |
237 | ||
5fd107e5 OB |
238 | * *Replication:* shows replication jobs and allows to create new ones. |
239 | ||
1a497fa7 WL |
240 | * *Permissions:* will manage user and group permission, LDAP, |
241 | MS-AD and Two-Factor authentication can be setup here. | |
242 | ||
243 | * *HA:* will manage the {pve} High-Availability | |
244 | ||
245 | * *Firewall:* on this level the Proxmox Firewall works cluster wide and | |
246 | makes templates which are cluster wide available. | |
247 | ||
248 | * *Support:* here you get all information about your support subscription. | |
249 | ||
250 | If you like to have more information about this see the corresponding chapter. | |
251 | ||
c8a14dea | 252 | |
5948aa79 DM |
253 | Nodes |
254 | ~~~~~ | |
c8a14dea | 255 | |
1ff5e4e8 | 256 | [thumbnail="screenshot/gui-node-summary.png"] |
c8a14dea | 257 | |
5fd107e5 OB |
258 | Nodes in your cluster can be managed invidiually at this level. |
259 | ||
260 | The top header has useful buttons such as 'Reboot', 'Shutdown', 'Shell', | |
261 | 'Bulk Actions' and 'Help'. | |
262 | 'Shell' has the options 'noVNC', 'SPICE' and 'xterm.js'. | |
263 | 'Bulk Actions' has the options 'Bulk Start', 'Bulk Stop' and 'Bulk Migrate'. | |
c8a14dea WL |
264 | |
265 | * *Search:* it is possible to search anything on the node, | |
266 | this can be a VM, Container, Storage or a pool. | |
267 | ||
7ec90af3 | 268 | * *Summary:* gives a brief overview over the resource usage. |
c8a14dea | 269 | |
5fd107e5 OB |
270 | * *Notes:* is where custom notes about a node can be written. |
271 | ||
57298d28 | 272 | * *Shell:* logs you into the shell of the node. |
c8a14dea | 273 | |
5fd107e5 | 274 | * *System:* is for configuring the network, DNS and time, and also shows your syslog. |
c8a14dea | 275 | |
5fd107e5 | 276 | * *Updates:* will upgrade the system and inform you about new packages. |
c8a14dea WL |
277 | |
278 | * *Firewall:* on this level is only for this node. | |
279 | ||
5fd107e5 | 280 | * *Disks:* gives you a brief overview about you physical hard drives and |
7ec90af3 | 281 | how they are used. |
c8a14dea | 282 | |
bc7e0c70 | 283 | * *Ceph:* is only used if you have installed a Ceph server on your |
7ec90af3 DC |
284 | host. Then you can manage your Ceph cluster and see the status |
285 | of it here. | |
c8a14dea | 286 | |
5fd107e5 OB |
287 | * *Replication:* shows replication jobs and allows to create new ones. |
288 | ||
57298d28 | 289 | * *Task History:* here all past tasks are shown. |
c8a14dea WL |
290 | |
291 | * *Subscription:* here you can upload you subscription key and get a | |
292 | system overview in case of a support case. | |
293 | ||
5948aa79 DM |
294 | |
295 | Guests | |
296 | ~~~~~~ | |
34ee078e | 297 | |
1ff5e4e8 | 298 | [thumbnail="screenshot/gui-qemu-summary.png"] |
34ee078e | 299 | |
3b652d4e WB |
300 | There are two different kinds of guests and both can be converted to a template. |
301 | One of them is a Kernel-based Virtual Machine (KVM) and the other one a Linux Container (LXC). | |
302 | Generally the navigation is the same, only some options are different. | |
34ee078e | 303 | |
bc7e0c70 | 304 | In the main management center the VM navigation begins if a VM is selected in the left tree. |
34ee078e | 305 | |
927f8feb | 306 | The top header contains important VM operation commands like 'Start', 'Shutdown', 'Reset', |
34ee078e | 307 | 'Remove', 'Migrate', 'Console' and 'Help'. |
03954d73 DC |
308 | Some of them have hidden buttons like 'Shutdown' has 'Stop' and |
309 | 'Console' contains the different console types 'SPICE', 'noVNC' and 'xterm.js'. | |
34ee078e | 310 | |
bc7e0c70 | 311 | On the right side the content switches depending on the selected option. |
34ee078e WL |
312 | |
313 | On the left side. | |
314 | All available options are listed one below the other. | |
315 | ||
316 | * *Summary:* gives a brief overview over the VM activity. | |
317 | ||
318 | * *Console:* an interactive console to your VM. | |
319 | ||
320 | * *(KVM)Hardware:* shows and set the Hardware of the KVM VM. | |
321 | ||
322 | * *(LXC)Resources:* defines the LXC Hardware opportunities. | |
323 | ||
324 | * *(LXC)Network:* the LXC Network settings. | |
325 | ||
326 | * *(LXC)DNS:* the LXC DNS settings. | |
327 | ||
57298d28 | 328 | * *Options:* all guest options can be set here. |
34ee078e | 329 | |
57298d28 | 330 | * *Task History:* here all previous tasks from the selected guest will be shown. |
34ee078e WL |
331 | |
332 | * *(KVM) Monitor:* is the interactive communication interface to the KVM process. | |
333 | ||
57298d28 | 334 | * *Backup:* shows the available backups from the selected guest and also create a backupset. |
34ee078e | 335 | |
57298d28 | 336 | * *Replication:* shows the replication jobs for the selected guest and allows to create new jobs. |
f423ae95 | 337 | |
34ee078e WL |
338 | * *Snapshots:* manage VM snapshots. |
339 | ||
340 | * *Firewall:* manage the firewall on VM level. | |
341 | ||
57298d28 | 342 | * *Permissions:* manage the user permission for the selected guest. |
34ee078e | 343 | |
5948aa79 DM |
344 | |
345 | Storage | |
346 | ~~~~~~~ | |
b83fcf1e | 347 | |
1ff5e4e8 | 348 | [thumbnail="screenshot/gui-storage-summary-local.png"] |
b83fcf1e | 349 | |
57298d28 | 350 | In this view we have a two partition split-view. |
b83fcf1e | 351 | On the left side we have the storage options |
bc7e0c70 | 352 | and on the right side the content of the selected option will be shown. |
b83fcf1e | 353 | |
3b652d4e | 354 | * *Summary:* shows important information about storages like |
b83fcf1e WL |
355 | 'Usage', 'Type', 'Content', 'Active' and 'Enabled'. |
356 | ||
3b652d4e | 357 | * *Content:* Here all content will be listed grouped by content type. |
b83fcf1e WL |
358 | |
359 | * *Permissions:* manage the user permission for this storage. | |
360 | ||
5948aa79 DM |
361 | |
362 | Pools | |
363 | ~~~~~ | |
871feac6 | 364 | |
1ff5e4e8 | 365 | [thumbnail="screenshot/gui-pool-summary-development.png"] |
871feac6 WL |
366 | |
367 | In this view we have a two partition split view. | |
368 | On the left side we have the logical pool options | |
bc7e0c70 | 369 | and on the right side the content of the selected option will be shown. |
871feac6 WL |
370 | |
371 | * *Summary:* show the description of the pool. | |
372 | ||
373 | * *Members:* Here all members of this pool will listed and can be managed. | |
374 | ||
375 | * *Permissions:* manage the user permission for this pool. | |
376 | ||
5948aa79 | 377 | |
c5eadcbd WL |
378 | ifdef::wiki[] |
379 | ||
380 | See Also | |
4736f1bc | 381 | -------- |
c5eadcbd WL |
382 | |
383 | * link:/wiki/Central_Web-based_Management | |
384 | ||
385 | endif::wiki[] | |
813e4036 | 386 | |
c5eadcbd WL |
387 | //// |
388 | TODO: | |
389 | ||
813e4036 | 390 | VM, CT, Storage, Pool section |
c5eadcbd WL |
391 | |
392 | //// |