* Two-Factor Authentication (OATH, Yubikey)
-* Based on ExtJS 6.x JavaScript framework
+* Based on ExtJS 7.x JavaScript framework
Login
-----
-[thumbnail="gui-login-window.png"]
+[thumbnail="screenshot/gui-login-window.png"]
-When you connect to the server, you will first see the longin window.
+When you connect to the server, you will first see the login window.
{pve} supports various authentication backends ('Realm'), and
-you can select the langauage here. The GUI is translated to more
+you can select the language here. The GUI is translated to more
than 20 languages.
-NOTE: You can save the user name on the client side by selection the
+NOTE: You can save the user name on the client side by selecting the
checkbox at the bottom. This saves some typing when you login next
time.
GUI Overview
------------
-[thumbnail="gui-datacenter-summary.png"]
+[thumbnail="screenshot/gui-datacenter-summary.png"]
The {pve} user interface consists of four regions.
Resource Tree:: At the left side. A navigation tree where you can select
specific objects.
-Content Panel:: Center region. Selected objects displays configuration
+Content Panel:: Center region. Selected objects display configuration
options and status here.
Log Panel:: At the bottom. Displays log entries for recent tasks. You
containers, nodes, ...). This is sometimes faster than selecting an
object in the resource tree.
-[thumbnail="gui-my-settings.png"]
-
-To the right of the search bar we see the identity (login name). The
-gear symbol is a button opening the 'My Settings' dialog. There you
-can customize some client side user interface setting (reset the saved
-login name, reset saved layout).
-
-The rightmost part of the header contains four buttons:
+The right part of the header contains four buttons:
[horizontal]
-Help :: Opens a new browser window showing the reference documenation.
+Documentation :: Opens a new browser window showing the reference documentation.
Create VM :: Opens the virtual machine creation wizard.
Create CT :: Open the container creation wizard.
-Logout :: Logout, and show the login dialog again.
+User Menu :: Displays the identity of the user you're currently logged in
+with, and clicking it opens a menu with user-specific options.
++
+In the user menu, you'll find the 'My Settings' dialog, which provides local UI
+settings. Below that, there are shortcuts for 'TFA' (Two-Factor Authentication)
+and 'Password' self-service. You'll also find options to change the 'Language'
+and the 'Color Theme.' Finally, at the bottom of the menu is the 'Logout'
+option.
+
+
+[[gui_my_settings]]
+My Settings
+~~~~~~~~~~~
+
+[thumbnail="screenshot/gui-my-settings.png"]
+
+The 'My Settings' window allows you to set locally stored settings. These
+include the 'Dashboard Storages' which allow you to enable or disable specific
+storages to be counted towards the total amount visible in the datacenter
+summary. If no storage is checked the total is the sum of all storages, same
+as enabling every single one.
+
+Below the dashboard settings you find the stored user name and a button to
+clear it as well as a button to reset every layout in the GUI to its default.
+
+On the right side there are 'xterm.js Settings'. These contain the following
+options:
+
+[horizontal]
+Font-Family :: The font to be used in xterm.js (e.g. Arial).
+
+Font-Size :: The preferred font size to be used.
+
+Letter Spacing :: Increases or decreases spacing between letters in text.
+
+Line Height :: Specify the absolute height of a line.
+
Resource Tree
~~~~~~~~~~~~~
This is the main navigation tree. On top of the tree you can select
-some predefined views, which changes the structure of the tree
-below. The default view is *Server View*, and it shows the following
+some predefined views, which change the structure of the tree
+below. The default view is the *Server View*, and it shows the following
object types:
[horizontal]
-Datacenter:: Contains cluster wide setting (relevant for all nodes).
+Datacenter:: Contains cluster-wide settings (relevant for all nodes).
-Node:: Represents the hosts inside a cluster, where the guests runs.
+Node:: Represents the hosts inside a cluster, where the guests run.
-Guest:: VMs, Containers and Templates.
+Guest:: VMs, containers and templates.
Storage:: Data Storage.
The following view types are available:
[horizontal]
-Server View:: Shows all kind of objects, grouped by nodes.
-
-Folder View:: Shows all kind of objects, grouped by object type.
+Server View:: Shows all kinds of objects, grouped by nodes.
-Storage View:: Only show storage objects, grouped by nodes.
+Folder View:: Shows all kinds of objects, grouped by object type.
-Pool View:: Show VMs and Containers, grouped by pool.
+Pool View:: Show VMs and containers, grouped by pool.
Log Panel
The main purpose of the log panel is to show you what is currently
going on in your cluster. Actions like creating an new VM are executed
-in background, and we call such background job a 'task'.
+in the background, and we call such a background job a 'task'.
-Any output from such task is saved into a separate log file. You can
+Any output from such a task is saved into a separate log file. You can
view that log by simply double-click a task log entry. It is also
possible to abort a running task there.
-Please note that we display most recent tasks from all cluster nodes
+Please note that we display the most recent tasks from all cluster nodes
here. So you can see when somebody else is working on another cluster
node in real-time.
NOTE: We remove older and finished task from the log panel to keep
-that list short. But you can still find those tasks in the 'Task
-History' within the node panel.
+that list short. But you can still find those tasks within the node panel in the
+'Task History'.
-Some short running actions simply sends logs to all cluster
+Some short-running actions simply send logs to all cluster
members. You can see those messages in the 'Cluster log' panel.
Content Panels
--------------
-When you select something in the resource tree, the corresponding
+When you select an item from the resource tree, the corresponding
object displays configuration and status information in the content
-panel. The following sections give a brief overview of the
-functionality. Please refer to the individual chapters inside the
-reference documentatin to get more detailed information.
+panel. The following sections provide a brief overview of this
+functionality. Please refer to the corresponding chapters in the
+reference documentation to get more detailed information.
Datacenter
~~~~~~~~~~
-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/gui-datacenter-search.png"]
+
+On the datacenter level, you can access cluster-wide settings and information.
+
+* *Search:* perform a cluster-wide search for nodes, VMs, containers, storage
+ devices, and pools.
+
+* *Summary:* gives a brief overview of the cluster's health and resource usage.
-On the datacenter level you can access cluster wide settings and information.
+* *Cluster:* provides the functionality and information necessary to create or
+ join a cluster.
-* *Search:* it is possible to search anything in cluster
-,this can be a node, VM, Container, Storage or a pool.
+* *Options:* view and manage cluster-wide default settings.
-* *Summary:* gives a brief overview over the cluster health.
+* *Storage:* provides an interface for managing cluster storage.
-* *Options:* can show and set defaults, which apply cluster wide.
+* *Backup:* schedule backup jobs. This operates cluster wide, so it doesn't
+ matter where the VMs/containers are on your cluster when scheduling.
-* *Storage:* is the place where a storage will add/managed/removed.
+* *Replication:* view and manage replication jobs.
-* *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:* manage user, group, and API token permissions, and LDAP,
+ MS-AD and Two-Factor authentication.
-* *Permissions:* will manage user and group permission, LDAP,
- MS-AD and Two-Factor authentication can be setup here.
+* *HA:* manage {pve} High Availability.
-* *HA:* will manage the {pve} High-Availability
+* *ACME:* set up ACME (Let's Encrypt) certificates for server nodes.
-* *Firewall:* on this level the Proxmox Firewall works cluster wide and
- makes templates which are cluster wide available.
+* *Firewall:* configure and make templates for the Proxmox Firewall cluster wide.
-* *Support:* here you get all information about your support subscription.
+* *Metric Server:* define external metric servers for {pve}.
-If you like to have more information about this see the corresponding chapter.
+* *Notifications:* configurate notification behavior and targets for {pve}.
+
+* *Support:* display information about your support subscription.
Nodes
~~~~~
-[thumbnail="gui-node-summary.png"]
+[thumbnail="screenshot/gui-node-summary.png"]
+
+Nodes in your cluster can be managed individually at this level.
+
+The top header has useful buttons such as 'Reboot', 'Shutdown', 'Shell',
+'Bulk Actions' and 'Help'.
+'Shell' has the options 'noVNC', 'SPICE' and 'xterm.js'.
+'Bulk Actions' has the options 'Bulk Start', 'Bulk Shutdown' and 'Bulk Migrate'.
-All belongs of a node can be managed at this level.
+* *Search:* search a node for VMs, containers, storage devices, and pools.
-* *Search:* it is possible to search anything on the node,
- this can be a VM, Container, Storage or a pool.
+* *Summary:* display a brief overview of the node's resource usage.
-* *Summary:* gives a brief overview over the resource usage.
+* *Notes:* write custom comments in xref:markdown_basics[Markdown syntax].
-* *Shell:* log you in the shell of the node.
+* *Shell:* access to a shell interface for the node.
-* *System:* is for configuring the network, dns and time, and also shows your syslog.
+* *System:* configure network, DNS and time settings, and access the syslog.
-* *Updates:* will upgrade the system and informs you about new packets.
+* *Updates:* upgrade the system and see the available new packages.
-* *Firewall:* on this level is only for this node.
+* *Firewall:* manage the Proxmox Firewall for a specific node.
-* *Disk:* gives you an brief overview about you physical hard drives and
- how they are used.
+* *Disks:* get an overview of the attached disks, and manage how they are used.
-* *Ceph:* is only used if you have installed a Ceph sever on you
- host. Then you can manage your Ceph cluster and see the status
+* *Ceph:* is only used if you have installed a Ceph server on your
+ host. In this case, you can manage your Ceph cluster and see the status
of it here.
-* *Task History:* here all past task are shown.
+* *Replication:* view and manage replication jobs.
-* *Subscription:* here you can upload you subscription key and get a
- system overview in case of a support case.
+* *Task History:* see a list of past tasks.
+
+* *Subscription:* upload a subscription key, and generate a system report for
+ use in support cases.
Guests
~~~~~~
-[thumbnail="gui-qemu-summary.png"]
+[thumbnail="screenshot/gui-qemu-summary.png"]
+
+There are two different kinds of guests and both can be converted to a template.
+One of them is a Kernel-based Virtual Machine (KVM) and the other is a Linux Container (LXC).
+Navigation for these are mostly the same; only some options are different.
-There are two differed kinds of VM types and both types can be converted to a template.
-One of them are Kernel-based Virtual Machine (KVM) and the other one are Linux Containers (LXC).
-General the navigation are the same only some option are different.
+To access the various guest management interfaces, select a VM or container from
+the menu on the left.
-In the main management center the VM navigation begin if a VM is selected in the left tree.
+The header contains commands for items such as power management, migration,
+console access and type, cloning, HA, and help.
+Some of these buttons contain drop-down menus, for example, 'Shutdown' also contains
+other power options, and 'Console' contains the different console types:
+'SPICE', 'noVNC' and 'xterm.js'.
-The top header contains important VM operation commands like 'Start', 'Shutdown', 'Rest',
-'Remove', 'Migrate', 'Console' and 'Help'.
-Two of them have hidden buttons like 'Shutdown' has 'Stop' and
-'Console' contains the different consolen typs 'SPICE' or 'noVNC'.
+The panel on the right contains an interface for whatever item is selected from
+the menu on the left.
-On the right side the content switch white the focus of the option.
+The available interfaces are as follows.
-On the left side.
-All available options are listed one below the other.
+* *Summary:* provides a brief overview of the VM's activity and a `Notes` field
+ for xref:markdown_basics[Markdown syntax] comments.
-* *Summary:* gives a brief overview over the VM activity.
+* *Console:* access to an interactive console for the VM/container.
-* *Console:* an interactive console to your VM.
+* *(KVM)Hardware:* define the hardware available to the KVM VM.
-* *(KVM)Hardware:* shows and set the Hardware of the KVM VM.
+* *(LXC)Resources:* define the system resources available to the LXC.
-* *(LXC)Resources:* defines the LXC Hardware opportunities.
+* *(LXC)Network:* configure a container's network settings.
-* *(LXC)Network:* the LXC Network settings.
+* *(LXC)DNS:* configure a container's DNS settings.
-* *(LXC)DNS:* the LXC DNS settings.
+* *Options:* manage guest options.
-* *Options:* all VM options can be set here, this distinguishes between KVM and LXC.
+* *Task History:* view all previous tasks related to the selected guest.
-* *Task History:* here all previous task from this VM will be shown.
+* *(KVM) Monitor:* an interactive communication interface to the KVM process.
-* *(KVM) Monitor:* is the interactive communication interface to the KVM process.
+* *Backup:* create and restore system backups.
-* *Backup:* shows the available backups from this VM and also create a backupset.
+* *Replication:* view and manage the replication jobs for the selected guest.
-* *Snapshots:* manage VM snapshots.
+* *Snapshots:* create and restore VM snapshots.
-* *Firewall:* manage the firewall on VM level.
+* *Firewall:* configure the firewall on the VM level.
-* *Permissions:* manage the user permission for this VM.
+* *Permissions:* manage permissions for the selected guest.
Storage
~~~~~~~
-[thumbnail="gui-storage-summary-local.png"]
+[thumbnail="screenshot/gui-storage-summary-local.png"]
-In this view we have a two partition split view.
+As with the guest interface, the interface for storage consists of a menu on the
+left for certain storage elements and an interface on the right to manage
+these elements.
+
+In this view we have a two partition split-view.
On the left side we have the storage options
-and on the right side the content of the selected option will shown.
+and on the right side the content of the selected option will be shown.
-* *Summary:* show you important information about your storage like
-'Usage', 'Type', 'Content', 'Active' and 'Enabled'.
+* *Summary:* shows important information about the storage, such as the type,
+ usage, and content which it stores.
-* *Content:* Here all contend will listed grouped by content.
+* *Content:* a menu item for each content type which the storage
+ stores, for example, Backups, ISO Images, CT Templates.
-* *Permissions:* manage the user permission for this storage.
+* *Permissions:* manage permissions for the storage.
Pools
~~~~~
-[thumbnail="gui-pool-summary-development.png"]
+[thumbnail="screenshot/gui-pool-summary-development.png"]
+
+Again, the pools view comprises two partitions: a menu on the left,
+and the corresponding interfaces for each menu item on the right.
+
+* *Summary:* shows a description of the pool.
+
+* *Members:* display and manage pool members (guests and storage).
+
+* *Permissions:* manage the permissions for the pool.
+
+
+Tags
+----
+
+[thumbnail="screenshot/gui-qemu-summary-tags-edit.png", float="left"]
+
+For organizational purposes, it is possible to set `tags` for guests.
+Currently, these only provide informational value to users.
+Tags are displayed in two places in the web interface: in the `Resource Tree` and
+in the status line when a guest is selected.
+
+Tags can be added, edited, and removed in the status line of the guest by
+clicking on the `pencil` icon. You can add multiple tags by pressing the `+`
+button and remove them by pressing the `-` button. To save or cancel the changes,
+you can use the `✓` and `x` button respectively.
+
+Tags can also be set via the CLI, where multiple tags are separated by semicolons.
+For example:
-In this view we have a two partition split view.
-On the left side we have the logical pool options
-and on the right side the content of the selected option will shown.
+----
+# qm set ID --tags myfirsttag;mysecondtag
+----
-* *Summary:* show the description of the pool.
+Style Configuration
+~~~~~~~~~~~~~~~~~~~
-* *Members:* Here all members of this pool will listed and can be managed.
+[thumbnail="screenshot/gui-datacenter-tag-style.png"]
-* *Permissions:* manage the user permission for this pool.
+By default, the tag colors are derived from their text in a deterministic way.
+The color, shape in the resource tree, and case-sensitivity, as well as how tags
+are sorted, can be customized. This can be done via the web interface under
+__Datacenter -> Options -> Tag Style Override__. Alternatively, this can be done
+via the CLI. For example:
+----
+# pvesh set /cluster/options --tag-style color-map=example:000000:FFFFFF
+----
+
+sets the background color of the tag `example` to black (#000000) and the text
+color to white (#FFFFFF).
+
+Permissions
+~~~~~~~~~~~
+
+[thumbnail="screenshot/gui-datacenter-options.png"]
+
+By default, users with the privilege `VM.Config.Options` on a guest (`/vms/ID`)
+can set any tags they want (see
+xref:pveum_permission_management[Permission Management]). If you want to
+restrict this behavior, appropriate permissions can be set under
+__Datacenter -> Options -> User Tag Access__:
+
+* `free`: users are not restricted in setting tags (Default)
+* `list`: users can set tags based on a predefined list of tags
+* `existing`: like list but users can also use already existing tags
+* `none`: users are restricted from using tags
+
+The same can also be done via the CLI.
+
+Note that a user with the `Sys.Modify` privileges on `/` is always able to set
+or delete any tags, regardless of the settings here. Additionally, there is a
+configurable list of `registered tags` which can only be added and removed by
+users with the privilege `Sys.Modify` on `/`. The list of registered tags can be
+edited under __Datacenter -> Options -> Registered Tags__ or via the CLI.
+
+
+For more details on the exact options and how to invoke them in the CLI, see
+xref:datacenter_configuration_file[Datacenter Configuration].
ifdef::wiki[]
endif::wiki[]
-////
-TODO:
-
-VM, CT, Storage, Pool section
-
-////
projects / pve-docs.git / blobdiff