]>
Commit | Line | Data |
---|---|---|
1 | [[chapter_gui]] | |
2 | Graphical User Interface | |
3 | ======================== | |
4 | ifndef::manvolnum[] | |
5 | :pve-toplevel: | |
6 | endif::manvolnum[] | |
7 | ||
8 | {pve} is simple. There is no need to install a separate management | |
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. | |
13 | ||
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. | |
17 | ||
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. | |
21 | ||
22 | The web interface can be reached via https://youripaddress:8006 | |
23 | (default login is: 'root', and the password is specified during the | |
24 | installation process). | |
25 | ||
26 | ||
27 | Features | |
28 | -------- | |
29 | ||
30 | * Seamless integration and management of {pve} clusters | |
31 | ||
32 | * AJAX technologies for dynamic updates of resources | |
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 | ||
40 | * Secure HTML5 console or SPICE | |
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 | |
51 | ||
52 | ||
53 | Login | |
54 | ----- | |
55 | ||
56 | [thumbnail="screenshot/gui-login-window.png"] | |
57 | ||
58 | When you connect to the server, you will first see the login window. | |
59 | {pve} supports various authentication backends ('Realm'), and | |
60 | you can select the language here. The GUI is translated to more | |
61 | than 20 languages. | |
62 | ||
63 | NOTE: You can save the user name on the client side by selecting the | |
64 | checkbox at the bottom. This saves some typing when you login next | |
65 | time. | |
66 | ||
67 | ||
68 | GUI Overview | |
69 | ------------ | |
70 | ||
71 | [thumbnail="screenshot/gui-datacenter-summary.png"] | |
72 | ||
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 display 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. | |
103 | ||
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] | |
112 | Help :: Opens a new browser window showing the reference documentation. | |
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 | ||
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 | ||
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 change the structure of the tree | |
155 | below. The default view is the *Server View*, and it shows the following | |
156 | object types: | |
157 | ||
158 | [horizontal] | |
159 | Datacenter:: Contains cluster-wide settings (relevant for all nodes). | |
160 | ||
161 | Node:: Represents the hosts inside a cluster, where the guests run. | |
162 | ||
163 | Guest:: VMs, containers and templates. | |
164 | ||
165 | Storage:: Data Storage. | |
166 | ||
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 kinds of objects, grouped by nodes. | |
175 | ||
176 | Folder View:: Shows all kinds of objects, grouped by object type. | |
177 | ||
178 | Storage View:: Only shows 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 the background, and we call such a background job a 'task'. | |
189 | ||
190 | Any output from such a 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 the 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 within the node panel in the | |
200 | 'Task History'. | |
201 | ||
202 | Some short-running actions simply send logs to all cluster | |
203 | members. You can see those messages in the 'Cluster log' panel. | |
204 | ||
205 | ||
206 | Content Panels | |
207 | -------------- | |
208 | ||
209 | When you select an item from the resource tree, the corresponding | |
210 | object displays configuration and status information in the content | |
211 | panel. The following sections provide a brief overview of this | |
212 | functionality. Please refer to the corresponding chapters in the | |
213 | reference documentation to get more detailed information. | |
214 | ||
215 | ||
216 | Datacenter | |
217 | ~~~~~~~~~~ | |
218 | ||
219 | [thumbnail="screenshot/gui-datacenter-search.png"] | |
220 | ||
221 | On the datacenter level, you can access cluster-wide settings and information. | |
222 | ||
223 | * *Search:* perform a cluster-wide search for nodes, VMs, containers, storage | |
224 | devices, and pools. | |
225 | ||
226 | * *Summary:* gives a brief overview of the cluster's health and resource usage. | |
227 | ||
228 | * *Cluster:* provides the functionality and information necessary to create or | |
229 | join a cluster. | |
230 | ||
231 | * *Options:* view and manage cluster-wide default settings. | |
232 | ||
233 | * *Storage:* provides an interface for managing cluster storage. | |
234 | ||
235 | * *Backup:* schedule backup jobs. This operates cluster wide, so it doesn't | |
236 | matter where the VMs/containers are on your cluster when scheduling. | |
237 | ||
238 | * *Replication:* view and manage replication jobs. | |
239 | ||
240 | * *Permissions:* manage user, group, and API token permissions, and LDAP, | |
241 | MS-AD and Two-Factor authentication. | |
242 | ||
243 | * *HA:* manage {pve} High Availability. | |
244 | ||
245 | * *ACME:* set up ACME (Let's Encrypt) certificates for server nodes. | |
246 | ||
247 | * *Firewall:* configure and make templates for the Proxmox Firewall cluster wide. | |
248 | ||
249 | * *Metric Server:* define external metric servers for {pve}. | |
250 | ||
251 | * *Support:* display information about your support subscription. | |
252 | ||
253 | ||
254 | Nodes | |
255 | ~~~~~ | |
256 | ||
257 | [thumbnail="screenshot/gui-node-summary.png"] | |
258 | ||
259 | Nodes in your cluster can be managed individually at this level. | |
260 | ||
261 | The top header has useful buttons such as 'Reboot', 'Shutdown', 'Shell', | |
262 | 'Bulk Actions' and 'Help'. | |
263 | 'Shell' has the options 'noVNC', 'SPICE' and 'xterm.js'. | |
264 | 'Bulk Actions' has the options 'Bulk Start', 'Bulk Stop' and 'Bulk Migrate'. | |
265 | ||
266 | * *Search:* search a node for VMs, containers, storage devices, and pools. | |
267 | ||
268 | * *Summary:* display a brief overview of the node's resource usage. | |
269 | ||
270 | * *Notes:* write custom comments in xref:markdown_basics[Markdown syntax]. | |
271 | ||
272 | * *Shell:* access to a shell interface for the node. | |
273 | ||
274 | * *System:* configure network, DNS and time settings, and access the syslog. | |
275 | ||
276 | * *Updates:* upgrade the system and see the available new packages. | |
277 | ||
278 | * *Firewall:* manage the Proxmox Firewall for a specific node. | |
279 | ||
280 | * *Disks:* get an overview of the attached disks, and manage how they are used. | |
281 | ||
282 | * *Ceph:* is only used if you have installed a Ceph server on your | |
283 | host. In this case, you can manage your Ceph cluster and see the status | |
284 | of it here. | |
285 | ||
286 | * *Replication:* view and manage replication jobs. | |
287 | ||
288 | * *Task History:* see a list of past tasks. | |
289 | ||
290 | * *Subscription:* upload a subscription key, and generate a system report for | |
291 | use in support cases. | |
292 | ||
293 | ||
294 | Guests | |
295 | ~~~~~~ | |
296 | ||
297 | [thumbnail="screenshot/gui-qemu-summary.png"] | |
298 | ||
299 | There are two different kinds of guests and both can be converted to a template. | |
300 | One of them is a Kernel-based Virtual Machine (KVM) and the other is a Linux Container (LXC). | |
301 | Navigation for these are mostly the same; only some options are different. | |
302 | ||
303 | To access the various guest management interfaces, select a VM or container from | |
304 | the menu on the left. | |
305 | ||
306 | The header contains commands for items such as power management, migration, | |
307 | console access and type, cloning, HA, and help. | |
308 | Some of these buttons contain drop-down menus, for example, 'Shutdown' also contains | |
309 | other power options, and 'Console' contains the different console types: | |
310 | 'SPICE', 'noVNC' and 'xterm.js'. | |
311 | ||
312 | The panel on the right contains an interface for whatever item is selected from | |
313 | the menu on the left. | |
314 | ||
315 | The available interfaces are as follows. | |
316 | ||
317 | * *Summary:* provides a brief overview of the VM's activity and a `Notes` field | |
318 | for xref:markdown_basics[Markdown syntax] comments. | |
319 | ||
320 | * *Console:* access to an interactive console for the VM/container. | |
321 | ||
322 | * *(KVM)Hardware:* define the hardware available to the KVM VM. | |
323 | ||
324 | * *(LXC)Resources:* define the system resources available to the LXC. | |
325 | ||
326 | * *(LXC)Network:* configure a container's network settings. | |
327 | ||
328 | * *(LXC)DNS:* configure a container's DNS settings. | |
329 | ||
330 | * *Options:* manage guest options. | |
331 | ||
332 | * *Task History:* view all previous tasks related to the selected guest. | |
333 | ||
334 | * *(KVM) Monitor:* an interactive communication interface to the KVM process. | |
335 | ||
336 | * *Backup:* create and restore system backups. | |
337 | ||
338 | * *Replication:* view and manage the replication jobs for the selected guest. | |
339 | ||
340 | * *Snapshots:* create and restore VM snapshots. | |
341 | ||
342 | * *Firewall:* configure the firewall on the VM level. | |
343 | ||
344 | * *Permissions:* manage permissions for the selected guest. | |
345 | ||
346 | ||
347 | Storage | |
348 | ~~~~~~~ | |
349 | ||
350 | [thumbnail="screenshot/gui-storage-summary-local.png"] | |
351 | ||
352 | As with the guest interface, the interface for storage consists of a menu on the | |
353 | left for certain storage elements and an interface on the right to manage | |
354 | these elements. | |
355 | ||
356 | In this view we have a two partition split-view. | |
357 | On the left side we have the storage options | |
358 | and on the right side the content of the selected option will be shown. | |
359 | ||
360 | * *Summary:* shows important information about the storage, such as the type, | |
361 | usage, and content which it stores. | |
362 | ||
363 | * *Content:* a menu item for each content type which the storage | |
364 | stores, for example, Backups, ISO Images, CT Templates. | |
365 | ||
366 | * *Permissions:* manage permissions for the storage. | |
367 | ||
368 | ||
369 | Pools | |
370 | ~~~~~ | |
371 | ||
372 | [thumbnail="screenshot/gui-pool-summary-development.png"] | |
373 | ||
374 | Again, the pools view comprises two partitions: a menu on the left, | |
375 | and the corresponding interfaces for each menu item on the right. | |
376 | ||
377 | * *Summary:* shows a description of the pool. | |
378 | ||
379 | * *Members:* display and manage pool members (guests and storage). | |
380 | ||
381 | * *Permissions:* manage the permissions for the pool. | |
382 | ||
383 | ||
384 | ifdef::wiki[] | |
385 | ||
386 | See Also | |
387 | -------- | |
388 | ||
389 | * link:/wiki/Central_Web-based_Management | |
390 | ||
391 | endif::wiki[] | |
392 |