pve-gui.adoc: use level1 headers

[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

////