fix #1975: extend 'My Settings' documentation
[pve-docs.git] / pve-gui.adoc
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 selection 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 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.
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 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.
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 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
209 When you select something in the resource tree, the corresponding
210 object displays configuration and status information in the content
211 panel. The following sections give a brief overview of the
212 functionality. Please refer to the individual chapters inside 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:* it is possible to search anything in cluster
224 ,this can be a node, VM, Container, Storage or a pool.
225
226 * *Summary:* gives a brief overview over the cluster health.
227
228 * *Options:* can show and set defaults, which apply cluster wide.
229
230 * *Storage:* is the place where a storage will add/managed/removed.
231
232 * *Backup:* has the capability to schedule Backups. This is
233    cluster wide, so you do not care about where the VM/Container are on
234    your cluster at schedule time.
235
236 * *Permissions:* will manage user and group permission, LDAP,
237    MS-AD and Two-Factor authentication can be setup here.
238
239 * *HA:* will manage the {pve} High-Availability
240
241 * *Firewall:* on this level the Proxmox Firewall works cluster wide and
242    makes templates which are cluster wide available.
243
244 * *Support:* here you get all information about your support subscription.
245
246 If you like to have more information about this see the corresponding chapter.
247
248
249 Nodes
250 ~~~~~
251
252 [thumbnail="screenshot/gui-node-summary.png"]
253
254 All belongs of a node can be managed at this level.
255
256 * *Search:* it is possible to search anything on the node,
257  this can be a VM, Container, Storage or a pool.
258
259 * *Summary:* gives a brief overview over the resource usage.
260
261 * *Shell:* log you in the shell of the node.
262
263 * *System:* is for configuring the network, dns and time, and also shows your syslog.
264
265 * *Updates:* will upgrade the system and informs you about new packets.
266
267 * *Firewall:* on this level is only for this node.
268
269 * *Disk:* gives you an brief overview about you physical hard drives and
270    how they are used.
271
272 * *Ceph:* is only used if you have installed a Ceph sever on you
273    host. Then you can manage your Ceph cluster and see the status
274    of it here.
275
276 * *Task History:* here all past task are shown.
277
278 * *Subscription:* here you can upload you subscription key and get a
279    system overview in case of a support case.
280
281
282 Guests
283 ~~~~~~
284
285 [thumbnail="screenshot/gui-qemu-summary.png"]
286
287 There are two differed kinds of VM types and both types can be converted to a template.
288 One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC).
289 General the navigation are the same only some option are different.
290
291 In the main management center the VM navigation begin if a VM is selected in the left tree.
292
293 The top header contains important VM operation commands like 'Start', 'Shutdown', 'Reset',
294 'Remove', 'Migrate', 'Console' and 'Help'.
295 Some of them have hidden buttons like 'Shutdown' has 'Stop' and
296 'Console' contains the different console types 'SPICE', 'noVNC' and 'xterm.js'.
297
298 On the right side the content switch white the focus of the option.
299
300 On the left side.
301 All available options are listed one below the other.
302
303 * *Summary:* gives a brief overview over the VM activity.
304
305 * *Console:* an interactive console to your VM.
306
307 * *(KVM)Hardware:* shows and set the Hardware of the KVM VM.
308
309 * *(LXC)Resources:* defines the LXC Hardware opportunities.
310
311 * *(LXC)Network:* the LXC Network settings.
312
313 * *(LXC)DNS:* the LXC DNS settings.
314
315 * *Options:* all VM options can be set here, this distinguishes between KVM and LXC.
316
317 * *Task History:* here all previous task from this VM will be shown.
318
319 * *(KVM) Monitor:* is the interactive communication interface to the KVM process.
320
321 * *Backup:* shows the available backups from this VM and also create a backupset.
322
323 * *Replication:* shows the replication jobs for this VM and allows to create new jobs.
324
325 * *Snapshots:* manage VM snapshots.
326
327 * *Firewall:* manage the firewall on VM level.
328
329 * *Permissions:* manage the user permission for this VM.
330
331
332 Storage
333 ~~~~~~~
334
335 [thumbnail="screenshot/gui-storage-summary-local.png"]
336
337 In this view we have a two partition split view.
338 On the left side we have the storage options
339 and on the right side the content of the selected option will shown.
340
341 * *Summary:* show you important information about your storage like
342 'Usage', 'Type', 'Content', 'Active' and 'Enabled'.
343
344 * *Content:* Here all contend will listed grouped by content.
345
346 * *Permissions:* manage the user permission for this storage.
347
348
349 Pools
350 ~~~~~
351
352 [thumbnail="screenshot/gui-pool-summary-development.png"]
353
354 In this view we have a two partition split view.
355 On the left side we have the logical pool options
356 and on the right side the content of the selected option will shown.
357
358 * *Summary:* show the description of the pool.
359
360 * *Members:* Here all members of this pool will listed and can be managed.
361
362 * *Permissions:* manage the user permission for this pool.
363
364
365 ifdef::wiki[]
366
367 See Also
368 --------
369
370 * link:/wiki/Central_Web-based_Management
371
372 endif::wiki[]
373
374 ////
375 TODO:
376
377 VM, CT, Storage, Pool section
378
379 ////