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