projects / proxmox-backup.git / blame
| Commit | Line | Data |
|---|---|---|
| a2bf8528 DW |
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 | :width: 250 | |
| 32 | :align: right | |
| 33 | :alt: PBS login window | |
| 34 | ||
| 35 | When you connect to the web interface, you will first see the login window. | |
| 3bbb70b3 | 36 | Proxmox Backup Server supports various languages and authentication back ends |
| a2bf8528 DW |
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 | :width: 250 | |
| 48 | :align: right | |
| 49 | :alt: PBS GUI Dashboard | |
| 50 | ||
| 51 | The Proxmox Backup Server web interface consists of 3 main sections: | |
| 52 | ||
| 53 | * **Header**: At the top. This shows version information, and contains buttons to view | |
| 54 | documentation, monitor running tasks, and logout. | |
| 55 | * **Sidebar**: On the left. This contains the configuration options for | |
| 56 | the server. | |
| 57 | * **Configuration Panel**: In the center. This contains the control interface for the | |
| 58 | configuration 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 configuration options, such as | |
| 80 | time and network configuration. It also contains the following subsections: | |
| 81 | ||
| 82 | * **User Management**: Add users and manage accounts | |
| 83 | * **Permissions**: Manage permissions for various users | |
| 84 | * **Remotes**: Add, edit and remove remotes (see :term:`Remote`) | |
| 85 | * **Sync Jobs**: Manage and run sync jobs to remotes | |
| 86 | * **Subscription**: Upload a subscription key and view subscription status | |
| 87 | ||
| 88 | ||
| 89 | Administration | |
| 90 | ^^^^^^^^^^^^^^ | |
| 91 | ||
| 92 | .. image:: images/screenshots/pbs-gui-administration-serverstatus.png | |
| 93 | :width: 250 | |
| 94 | :align: right | |
| 95 | :alt: Administration: Server Status overview | |
| 96 | ||
| 97 | The Administration section contains a top panel, with further administration | |
| 98 | tasks and information. These are: | |
| 99 | ||
| 100 | * **ServerStatus**: Provides access to the console, power options, and various | |
| 101 | resource usage statistics | |
| 102 | * **Services**: Manage and monitor system services | |
| 103 | * **Updates**: An interface for upgrading packages | |
| 104 | * **Syslog**: View log messages from the server | |
| 105 | * **Tasks**: Task history with multiple filter options | |
| 106 | ||
| 107 | .. image:: images/screenshots/pbs-gui-disks.png | |
| 108 | :width: 250 | |
| 109 | :align: right | |
| 110 | :alt: Administration: Disks | |
| 111 | ||
| 112 | The administration menu item also contains a disk management subsection: | |
| 113 | ||
| 114 | * **Disks**: View information on available disks | |
| 115 | ||
| 116 | * **Directory**: Create and view information on *ext4* and *xfs* disks | |
| 117 | * **ZFS**: Create and view information on *ZFS* disks | |
| 118 | ||
| 119 | ||
| 120 | Datastore | |
| 121 | ^^^^^^^^^ | |
| 122 | ||
| 123 | .. image:: images/screenshots/pbs-gui-datastore.png | |
| 124 | :width: 250 | |
| 125 | :align: right | |
| 126 | :alt: Datastore Configuration | |
| 127 | ||
| 128 | The Datastore section provides an interface for creating and managing | |
| 129 | datastores. It contains a subsection for each datastore on the system, in | |
| 130 | which you can use the top panel to view: | |
| 131 | ||
| 132 | * **Content**: Information on the datastore's backup groups and their respective | |
| 133 | contents | |
| 134 | * **Statistics**: Usage statistics for the datastore | |
| 135 | * **Permissions**: View and manage permissions for the datastore |