small corrections and clarifications
[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, everything can be done via your web browser (Latest Firefox and
10 Google Chrome is preferred). To access VM/CT console, a built in HTML5
11 console is used. As alternative, SPICE can be used.
12
13 As we use Proxmox Cluster file system (pmxcfs),you can connect to any
14 node to manage the whole cluster.
15
16 To use the Central Web-based Management, you need a modern browser,
17 this includes:
18
19 * Firefox, a release from the current year, or the latest Enterprise
20 * Support Release Chrome, a release from the current year
21 * Microsoft currently supported versions of Edge Browser
22 * Apple currently supported versions of Safari
23
24 If {pve} detect you're connecting from a mobile device, you will
25 redirected to a light weight touch based UI.
26
27 The web interface can be reached via https://youripaddress:8006
28 (default login is: root, the password is specified during the
29 installation).
30
31
32 Features
33 --------
34
35 * Seamless integration and management of Proxmox VE 4.x Cluster
36 * AJAX technologies for dynamic updates of resources
37 * Secure access to all Virtual Machines and Containers via SSL encryption (https)
38 * Fast search-driven interface, capable of handling hundreds and probably thousands of VMs
39 * Secure HTML5 console or SPICE
40 * Role based permission management for all objects (VMs, storages, nodes, etc.)
41 * Support for multiple authentication sources (e.g. local, MS ADS, LDAP, ...)
42 * Two-Factor Authentication
43 * Proxmox VE Firewall
44 * Based on Ext JS 6.x JavaScript framework
45
46
47 GUI Overview
48 ------------
49
50 [thumbnail="gui-datacenter-summary.png"]
51
52 The GUI has 3 sections:
53
54 * On the left side is the navigation bar. On the top, you can select one of 4
55   views. Those views change the structure of the tree below. The default
56   selection is *Server View* and it has the following 4 types of elements.
57 ** Datacenter: contains all the settings belonging to all machines.
58 ** Nodes: represent the host where the VM/CT runs on. It is named like
59    the hostname. Normally the name was set by the installation.
60 ** Entity: can be a VM, container, a template or a storage.
61 ** Logical pools: it is possible to group entities to a group for easy management.
62 * On the right side is the main management center, where all content
63   of the selected entity form the navigation bar is shown.
64 * On the bottom is the task log section, where all tasks are shown.
65
66
67 Dataceter Level
68 ---------------
69
70 [thumbnail="gui-datacenter-search.png"]
71
72 On the datacenter level you can access cluster wide settings and information.
73
74 * *Search:* it is possible to search anything in cluster
75 ,this can be a node, VM, Container, Storage or a pool.
76
77 * *Summary:* gives a brief overview over the cluster health.
78
79 * *Options:* can show and set defaults, which apply cluster wide.
80
81 * *Storage:* is the place where a storage will add/managed/removed.
82
83 * *Backup:* has the capability to schedule Backups. This is
84    cluster wide, so you do not care about where the VM/Container are on
85    your cluster at schedule time.
86
87 * *Permissions:* will manage user and group permission, LDAP,
88    MS-AD and Two-Factor authentication can be setup here.
89
90 * *HA:* will manage the {pve} High-Availability
91
92 * *Firewall:* on this level the Proxmox Firewall works cluster wide and
93    makes templates which are cluster wide available.
94
95 * *Support:* here you get all information about your support subscription.
96
97 If you like to have more information about this see the corresponding chapter.
98
99
100 Node Level
101 ----------
102
103 [thumbnail="gui-node-summary.png"]
104
105 All belongs of a node can be managed at this level.
106
107 * *Search:* it is possible to search anything on the node,
108  this can be a VM, Container, Storage or a pool.
109
110 * *Summary:* gives a brief overview over the resource usage.
111
112 * *Shell:* log you in the shell of the node.
113
114 * *System:* is for configuring the network, dns and time, and also shows your syslog.
115
116 * *Updates:* will upgrade the system and informs you about new packets.
117
118 * *Firewall:* on this level is only for this node.
119
120 * *Disk:* gives you an brief overview about you physical hard drives and
121    how they are used.
122
123 * *Ceph:* is only used if you have installed a Ceph sever on you
124    host. Then you can manage your Ceph cluster and see the status
125    of it here.
126
127 * *Task History:* here all past task are shown.
128
129 * *Subscription:* here you can upload you subscription key and get a
130    system overview in case of a support case.
131
132 ifdef::wiki[]
133
134 See Also
135 --------
136
137 * link:/wiki/Central_Web-based_Management
138
139 endif::wiki[]
140
141 ////
142 TODO:
143
144 VM, CT, Storage, Pool section
145
146 ////