docs/gui.rst

   1 Graphical User Interface
   2 ========================
   3
   4 Proxmox Backup Server offers an integrated, web-based interface to manage the
   5 server. This means that you can carry out all administration tasks through your
   6 web browser, and that you don't have to worry about installing extra management
   7 tools. The web interface also provides a built-in console, so if you prefer the
   8 command line or need some extra control, you have this option.
   9
  10 The web interface can be accessed via https://youripaddress:8007. The default
  11 login is `root`, and the password is the one specified during the installation
  12 process.
  13
  14
  15 Features
  16 --------
  17
  18 * Simple management interface for Proxmox Backup Server
  19 * Monitoring of tasks, logs and resource usage
  20 * Management of users, permissions, datastores, etc.
  21 * Secure HTML5 console
  22 * Support for multiple authentication sources
  23 * Support for multiple languages
  24 * Based on ExtJS 6.x JavaScript framework
  25
  26
  27 Login
  28 -----
  29
  30 .. image:: images/screenshots/pbs-gui-login-window.png
  31   :align: right
  32   :alt: PBS login window
  33
  34 When you connect to the web interface, you will first see the login window.
  35 Proxmox Backup Server supports various languages and authentication back ends
  36 (*Realms*), both of which can be selected here.
  37
  38 .. note:: For convenience, you can save the username on the client side, by
  39   selecting the "Save User name" checkbox at the bottom of the window.
  40
  41
  42 GUI Overview
  43 ------------
  44
  45 .. image:: images/screenshots/pbs-gui-dashboard.png
  46   :align: right
  47   :alt: PBS GUI Dashboard
  48
  49 The Proxmox Backup Server web interface consists of 3 main sections:
  50
  51 * **Header**: At the top. This shows version information, and contains buttons to view
  52   documentation, monitor running tasks, set the language and logout.
  53 * **Sidebar**: On the left. This contains the configuration options for
  54   the server.
  55 * **Configuration Panel**: In the center. This contains the control interface for the
  56   configuration options in the *Sidebar*.
  57
  58
  59 Sidebar
  60 -------
  61
  62 In the sidebar, on the left side of the page, you can see various items relating
  63 to specific management activities.
  64
  65
  66 Dashboard
  67 ^^^^^^^^^
  68
  69 The Dashboard shows a summary of activity and resource usage on the server.
  70 Specifically, this displays hardware usage, a summary of
  71 previous and currently running tasks, and subscription information.
  72
  73
  74 Configuration
  75 ^^^^^^^^^^^^^
  76
  77 The Configuration section contains some system configuration options, such as
  78 time and network configuration. It also contains the following subsections:
  79
  80 * **Access Control**: Add and manage users, API tokens, and the permissions
  81   associated with these items
  82 * **Remotes**: Add, edit and remove remotes (see :term:`Remote`)
  83 * **Subscription**: Upload a subscription key, view subscription status and
  84   access a text-based system report.
  85
  86
  87 Administration
  88 ^^^^^^^^^^^^^^
  89
  90 .. image:: images/screenshots/pbs-gui-administration-serverstatus.png
  91   :align: right
  92   :alt: Administration: Server Status overview
  93
  94 The Administration section contains a top panel, with further administration
  95 tasks and information. These are:
  96
  97 * **ServerStatus**: Provides access to the console, power options, and various
  98   resource usage statistics
  99 * **Services**: Manage and monitor system services
 100 * **Updates**: An interface for upgrading packages
 101 * **Syslog**: View log messages from the server
 102 * **Tasks**: Task history with multiple filter options
 103
 104 .. image:: images/screenshots/pbs-gui-disks.png
 105   :align: right
 106   :alt: Administration: Disks
 107
 108 The administration menu item also contains a disk management subsection:
 109
 110 * **Disks**: View information on available disks
 111
 112   * **Directory**: Create and view information on *ext4* and *xfs* disks
 113   * **ZFS**: Create and view information on *ZFS* disks
 114
 115
 116 Datastore
 117 ^^^^^^^^^
 118
 119 .. image:: images/screenshots/pbs-gui-datastore-summary.png
 120   :align: right
 121   :alt: Datastore Configuration
 122
 123 The Datastore section contains interfaces for creating and managing
 124 datastores. It contains a button to create a new datastore on the server, as
 125 well as a subsection for each datastore on the system, in which you can use the
 126 top panel to view:
 127
 128 * **Summary**: Access a range of datastore usage statistics
 129 * **Content**: Information on the datastore's backup groups and their respective
 130   contents
 131 * **Prune & GC**: Schedule :ref:`pruning <backup-pruning>` and :ref:`garbage
 132   collection <garbage-collection>` operations, and run garbage collection
 133   manually
 134 * **Sync Jobs**: Create, manage and run :ref:`syncjobs` from remote servers
 135 * **Verify Jobs**: Create, manage and run :ref:`verification` jobs on the
 136   datastore