pveceph: add pg_num for easier search

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

diff --git a/pve-gui.adoc b/pve-gui.adoc
index 88faa43f7fdb152ccdaa3e018b500651106578d6..78a2294ebdb9e17a731fb905b27d0407d46c488a 100644 (file)
--- a/pve-gui.adoc
+++ b/pve-gui.adoc
@@ -53,11 +53,11 @@ Features
 Login
 -----
 
 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
 {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
 than 20 languages.
 
 NOTE: You can save the user name on the client side by selection the


@@ -68,7 +68,7 @@ time.
 GUI Overview
 ------------
 
 GUI Overview
 ------------
 

-[thumbnail="gui-datacenter-summary.png"]
+[thumbnail="screenshot/gui-datacenter-summary.png"]

 
 The {pve} user interface consists of four regions.
 
 
 The {pve} user interface consists of four regions.
 


@@ -101,8 +101,6 @@ search bar nearside you can search for specific objects (VMs,
 containers, nodes, ...). This is sometimes faster than selecting an
 object in the resource tree.
 
 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
 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


@@ -111,7 +109,7 @@ login name, reset saved layout).
 The rightmost part of the header contains four buttons:
 
 [horizontal]
 The rightmost part of the header contains four buttons:
 
 [horizontal]

-Help :: Opens a new browser window showing the reference documenation.
+Help :: Opens a new browser window showing the reference documentation.

 
 Create VM :: Opens the virtual machine creation wizard.
 
 
 Create VM :: Opens the virtual machine creation wizard.
 


@@ -120,6 +118,35 @@ Create CT :: Open the container creation wizard.
 Logout :: Logout, and show the login dialog again.
 
 
 Logout :: Logout, and show the login dialog again.
 
 

+[[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
 ~~~~~~~~~~~~~
 
 Resource Tree
 ~~~~~~~~~~~~~
 


@@ -183,13 +210,13 @@ When you select something in 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
 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.
+reference documentation to get more detailed information.

 
 
 Datacenter
 ~~~~~~~~~~
 
 
 
 Datacenter
 ~~~~~~~~~~
 

-[thumbnail="gui-datacenter-search.png"]
+[thumbnail="screenshot/gui-datacenter-search.png"]

 
 On the datacenter level you can access cluster wide settings and information.
 
 
 On the datacenter level you can access cluster wide settings and information.
 


@@ -222,7 +249,7 @@ If you like to have more information about this see the corresponding chapter.
 Nodes
 ~~~~~
 
 Nodes
 ~~~~~
 

-[thumbnail="gui-node-summary.png"]
+[thumbnail="screenshot/gui-node-summary.png"]

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


@@ -255,7 +282,7 @@ All belongs of a node can be managed at this level.
 Guests
 ~~~~~~
 
 Guests
 ~~~~~~
 

-[thumbnail="gui-qemu-summary.png"]
+[thumbnail="screenshot/gui-qemu-summary.png"]

 
 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).
 
 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).


@@ -263,10 +290,10 @@ General the navigation are the same only some option are different.
 
 In the main management center the VM navigation begin if a VM is selected in the left tree.
 
 
 In the main management center the VM navigation begin if a VM is selected in the left tree.
 

-The top header contains important VM operation commands like 'Start', 'Shutdown', 'Rest',
+The top header contains important VM operation commands like 'Start', 'Shutdown', 'Reset',

 'Remove', 'Migrate', 'Console' and 'Help'.
 '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'.
+Some of them have hidden buttons like 'Shutdown' has 'Stop' and
+'Console' contains the different console types 'SPICE', 'noVNC' and 'xterm.js'.

 
 On the right side the content switch white the focus of the option.
 
 
 On the right side the content switch white the focus of the option.
 


@@ -293,6 +320,8 @@ All available options are listed one below the other.
 
 * *Backup:* shows the available backups from this VM and also create a backupset.
 
 
 * *Backup:* shows the available backups from this VM and also create a backupset.
 

+* *Replication:* shows the replication jobs for this VM and allows to create new jobs.
+

 * *Snapshots:* manage VM snapshots.
 
 * *Firewall:* manage the firewall on VM level.
 * *Snapshots:* manage VM snapshots.
 
 * *Firewall:* manage the firewall on VM level.


@@ -303,7 +332,7 @@ All available options are listed one below the other.
 Storage
 ~~~~~~~
 
 Storage
 ~~~~~~~
 

-[thumbnail="gui-storage-summary-local.png"]
+[thumbnail="screenshot/gui-storage-summary-local.png"]

 
 In this view we have a two partition split view.
 On the left side we have the storage options
 
 In this view we have a two partition split view.
 On the left side we have the storage options


@@ -320,7 +349,7 @@ and on the right side the content of the selected option will shown.
 Pools
 ~~~~~
 
 Pools
 ~~~~~
 

-[thumbnail="gui-pool-summary-development.png"]
+[thumbnail="screenshot/gui-pool-summary-development.png"]

 
 In this view we have a two partition split view.
 On the left side we have the logical pool options
 
 In this view we have a two partition split view.
 On the left side we have the logical pool options