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 either the one specified during the
  12 installation process or the password of the root user, in case of installation
  13 on top of Debian.
  14
  15
  16 Features
  17 --------
  18
  19 * Simple management interface for Proxmox Backup Server
  20 * Monitoring of tasks, logs and resource usage
  21 * Management of users, permissions, datastores, etc.
  22 * Secure HTML5 console
  23 * Support for multiple authentication sources
  24 * Support for multiple languages
  25 * Based on ExtJS 6.x JavaScript framework
  26
  27
  28 Login
  29 -----
  30
  31 .. image:: images/screenshots/pbs-gui-login-window.png
  32   :align: right
  33   :alt: PBS login window
  34
  35 When you connect to the web interface, you will first see the login window.
  36 Proxmox Backup Server supports various languages and authentication back ends
  37 (*Realms*), both of which can be selected here.
  38
  39 .. note:: For convenience, you can save the username on the client side, by
  40   selecting the "Save User name" checkbox at the bottom of the window.
  41
  42
  43 GUI Overview
  44 ------------
  45
  46 .. image:: images/screenshots/pbs-gui-dashboard.png
  47   :align: right
  48   :alt: PBS GUI Dashboard
  49
  50 The Proxmox Backup Server web interface consists of 3 main sections:
  51
  52 * **Header**: At the top. This shows version information and contains buttons to
  53   view documentation, monitor running tasks, set the language, configure various
  54   display settings, and logout.
  55 * **Sidebar**: On the left. This contains the administration options for
  56   the server.
  57 * **Configuration Panel**: In the center. This contains the respective control
  58   interfaces for the administration options in the *Sidebar*.
  59
  60
  61 Sidebar
  62 -------
  63
  64 In the sidebar, on the left side of the page, you can see various items relating
  65 to specific management activities.
  66
  67
  68 Dashboard
  69 ^^^^^^^^^
  70
  71 The Dashboard shows a summary of activity and resource usage on the server.
  72 Specifically, this displays hardware usage, a summary of
  73 previous and currently running tasks, and subscription information.
  74
  75
  76 Configuration
  77 ^^^^^^^^^^^^^
  78
  79 The Configuration section contains some system options, such as time, network,
  80 WebAuthn, and HTTP proxy configuration. It also contains the following
  81 subsections:
  82
  83 * **Access Control**: Add and manage users, API tokens, and the permissions
  84   associated with these items
  85 * **Remotes**: Add, edit and remove remotes (see :term:`Remote`)
  86 * **Certificates**: Manage ACME accounts and create SSL certificates.
  87 * **Subscription**: Upload a subscription key, view subscription status and
  88   access a text-based system report.
  89
  90
  91 Administration
  92 ^^^^^^^^^^^^^^
  93
  94 .. image:: images/screenshots/pbs-gui-administration-serverstatus.png
  95   :align: right
  96   :alt: Administration: Server Status overview
  97
  98 The Administration section contains a top panel, with further administration
  99 tasks and information. These are:
 100
 101 * **ServerStatus**: Provides access to the console, power options, and various
 102   resource usage statistics
 103 * **Services**: Manage and monitor system services
 104 * **Updates**: An interface for upgrading packages
 105 * **Repositories**: An interface for configuring APT repositories
 106 * **Syslog**: View log messages from the server
 107 * **Tasks**: Task history with multiple filter options
 108
 109 .. image:: images/screenshots/pbs-gui-disks.png
 110   :align: right
 111   :alt: Administration: Disks
 112
 113 The administration menu item also contains a disk management subsection:
 114
 115 * **Disks**: View information on available disks
 116
 117   * **Directory**: Create and view information on *ext4* and *xfs* disks
 118   * **ZFS**: Create and view information on *ZFS* disks
 119
 120 Tape Backup
 121 ^^^^^^^^^^^
 122
 123 .. image:: images/screenshots/pbs-gui-tape-changer-overview.png
 124   :align: right
 125   :alt: Tape Backup: Tape changer overview
 126
 127 The `Tape Backup`_ section contains a top panel, with options for managing tape
 128 media sets, inventories, drives, changers, encryption keys, and the tape backup
 129 jobs itself. The tabs are as follows:
 130
 131 * **Content**: Information on the contents of the tape backup
 132 * **Inventory**: Manage the tapes attached to the system
 133 * **Changers**: Manage tape loading devices
 134 * **Drives**: Manage drives used for reading and writing to tapes
 135 * **Media Pools**: Manage logical pools of tapes
 136 * **Encryption Keys**: Manage tape backup encryption keys
 137 * **Backup Jobs**: Manage tape backup jobs
 138
 139 The section also contains a subsection per standalone drive and per changer,
 140 with a status and management view for those devices.
 141
 142 Datastore
 143 ^^^^^^^^^
 144
 145 .. image:: images/screenshots/pbs-gui-datastore-summary.png
 146   :align: right
 147   :alt: Datastore Configuration
 148
 149 The Datastore section contains interfaces for creating and managing
 150 datastores. It also contains a button for creating a new datastore on the
 151 server, as well as a subsection for each datastore on the system, in which you
 152 can use the top panel to view:
 153
 154 * **Summary**: Access a range of datastore usage statistics
 155 * **Content**: Information on the datastore's backup groups and their respective
 156   contents
 157 * **Prune & GC**: Schedule :ref:`pruning <backup-pruning>` and :ref:`garbage
 158   collection <client_garbage-collection>` operations, and run garbage collection
 159   manually
 160 * **Sync Jobs**: Create, manage and run :ref:`syncjobs` from remote servers
 161 * **Verify Jobs**: Create, manage and run :ref:`maintenance_verification` jobs
 162   on the datastore
 163 * **Options**: Configure notification and verification settings
 164 * **Permissions**: Manage permissions on the datastore