[pve-docs.git] / pve-gui.adoc

[[chapter_gui]]
Graphical User Interface
========================
ifndef::manvolnum[]
:pve-toplevel:
endif::manvolnum[]

{pve} is simple. There is no need to install a separate management
tool, everything can be done via your web browser (Latest Firefox and
Google Chrome is preferred). To access VM/CT console, a built in HTML5
console is used. As alternative, SPICE can be used.

As we use Proxmox Cluster file system (pmxcfs),you can connect to any
node to manage the whole cluster.

To use the Central Web-based Management, you need a modern browser,
this includes:

* Firefox, a release from the current year, or the latest Enterprise
* Support Release Chrome, a release from the current year
* Microsoft currently supported versions of Edge Browser
* Apple currently supported versions of Safari

If {pve} detect you're connecting from a mobile device, you will
redirected to a light weight touch based UI.

The web interface can be reached via https://youripaddress:8006
(default login is: root, the password is specified during the
installation).


Features
--------

* Seamless integration and management of Proxmox VE 4.x Cluster
* AJAX technologies for dynamic updates of resources
* Secure access to all Virtual Machines and Containers via SSL encryption (https)
* Fast search-driven interface, capable of handling hundreds and probably thousands of VMs
* Secure HTML5 console or SPICE
* Role based permission management for all objects (VMs, storages, nodes, etc.)
* Support for multiple authentication sources (e.g. local, MS ADS, LDAP, ...)
* Two-Factor Authentication
* Proxmox VE Firewall
* Based on Ext JS 6.x JavaScript framework


GUI Overview
------------

[thumbnail="gui-datacenter-summary.png"]

The GUI has 3 sectors:

* On the left side is the navigation bar. The navigation bar is
  structured into 4 different types. It has 4 different views,
  which can be selected on the top.
** Datacenter: contains all the settings belonging to all machines.
** Nodes: represent the host where the VM/CT runs on. It is named like
   the hostname. Normally the name was set by the installation.
** Entity: can be a VM, container or a storage.
** Logical pools: it is possible to group entities to a group for easy management.
* On the right side is the main management center, where all content
  of the selected entity form the navigation bar is shown.
* On the bottom is the task log section, where all tasks are shown.


Dataceter Level
---------------

[thumbnail="gui-datacenter-search.png"]

On the datacenter level you can manage cluster wide settings and get
information about this cluster.

* *Search:* it is possible to search anything in cluster
,this can be a node, VM, Container, Storage or a pool.

* *Summery:* gives a brief overview over the cluster health.

* *Options:* can show and set defaults, which apply cluster wide.

* *Storage:* is the place where a storage will add/managed/removed.

* *Backup:* has the capability to schedule Backups. This is
   cluster wide, so you do not care about where the VM/Container are on
   your cluster at schedule time.

* *Permissions:* will manage user and group permission, LDAP,
   MS-AD and Two-Factor authentication can be setup here.

* *HA:* will manage the {pve} High-Availability

* *Firewall:* on this level the Proxmox Firewall works cluster wide and
   makes templates which are cluster wide available.

* *Support:* here you get all information about your support subscription.

If you like to have more information about this see the corresponding chapter.


Node Level
----------

[thumbnail="gui-node-summary.png"]

All belongs of a node can be managed at this level.

* *Search:* it is possible to search anything on the node,
 this can be a VM, Container, Storage or a pool.

* *Summery:* gives a brief overview over the resource usage.

* *Shell:* log you in the shell of the node.

* *System:* is for configuration like network, time and shows your syslog.

* *Updates:* will upgrade the system and inform you about new packets.

* *Firewall:* on this level is only for this node.

* *Disk:* gives you an brief overview about you physical hard drives and
   how do you use them.

* *Ceph:* is only used if you have installed a Ceph sever on you
   host. Then you can here manage your Ceph cluster and see the status
   of it.

* *Task History:* here all past task are shown.

* *Subscription:* here you can upload you subscription key and get a
   system overview in case of a support case.

ifdef::wiki[]

See Also
--------

* link:/wiki/Central_Web-based_Management

endif::wiki[]

////
TODO:

VM, CT, Storage, Pool section

////
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, 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 sectors:
	53
	54	* On the left side is the navigation bar. The navigation bar is
	55	structured into 4 different types. It has 4 different views,
	56	which can be selected on the top.
	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 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 manage cluster wide settings and get
	73	information about this cluster.
	74
	75	* Search: it is possible to search anything in cluster
	76	,this can be a node, VM, Container, Storage or a pool.
	77
	78	* Summery: gives a brief overview over the cluster health.
	79
	80	* Options: can show and set defaults, which apply cluster wide.
	81
	82	* Storage: is the place where a storage will add/managed/removed.
	83
	84	* Backup: has the capability to schedule Backups. This is
	85	cluster wide, so you do not care about where the VM/Container are on
	86	your cluster at schedule time.
	87
	88	* Permissions: will manage user and group permission, LDAP,
	89	MS-AD and Two-Factor authentication can be setup here.
	90
	91	* HA: will manage the {pve} High-Availability
	92
	93	* Firewall: on this level the Proxmox Firewall works cluster wide and
	94	makes templates which are cluster wide available.
	95
	96	* Support: here you get all information about your support subscription.
	97
	98	If you like to have more information about this see the corresponding chapter.
	99
	100
	101	Node Level
	102	----------
	103
	104	[thumbnail="gui-node-summary.png"]
	105
	106	All belongs of a node can be managed at this level.
	107
	108	* Search: it is possible to search anything on the node,
	109	this can be a VM, Container, Storage or a pool.
	110
	111	* Summery: gives a brief overview over the resource usage.
	112
	113	* Shell: log you in the shell of the node.
	114
	115	* System: is for configuration like network, time and shows your syslog.
	116
	117	* Updates: will upgrade the system and inform you about new packets.
	118
	119	* Firewall: on this level is only for this node.
	120
	121	* Disk: gives you an brief overview about you physical hard drives and
	122	how do you use them.
	123
	124	* Ceph: is only used if you have installed a Ceph sever on you
	125	host. Then you can here manage your Ceph cluster and see the status
	126	of it.
	127
	128	* Task History: here all past task are shown.
	129
	130	* Subscription: here you can upload you subscription key and get a
	131	system overview in case of a support case.
	132
	133	ifdef::wiki[]
	134
	135	See Also
	136	--------
	137
	138	* link:/wiki/Central_Web-based_Management
	139
	140	endif::wiki[]
	141
	142	////
	143	TODO:
	144
	145	VM, CT, Storage, Pool section
	146
	147	////