]>
Commit | Line | Data |
---|---|---|
7e688b71 DM |
1 | Introduction |
2 | ============ | |
3 | ||
d9f365d7 | 4 | What is Proxmox Backup Server? |
2357744b | 5 | ------------------------------ |
7e688b71 | 6 | |
717ce406 | 7 | Proxmox Backup Server is an enterprise-class, client-server backup solution that |
e1dc2d22 SI |
8 | is capable of backing up :term:`virtual machine<Virtual machine>`\ s, |
9 | :term:`container<Container>`\ s, and physical hosts. It is specially optimized | |
10 | for the `Proxmox Virtual Environment`_ platform and allows you to back up your | |
11 | data securely, even between remote sites, providing easy management through a | |
12 | web-based user interface. | |
6a1cb691 | 13 | |
d9f365d7 | 14 | It supports deduplication, compression, and authenticated |
717ce406 DW |
15 | encryption (AE_). Using :term:`Rust` as the implementation language guarantees |
16 | high performance, low resource usage, and a safe, high-quality codebase. | |
6a1cb691 | 17 | |
44a5f38b | 18 | Proxmox Backup uses state of the art cryptography for both client-server |
a98e2287 | 19 | communication and backup content :ref:`encryption <client_encryption>`. All |
44a5f38b DW |
20 | client-server communication uses `TLS |
21 | <https://en.wikipedia.org/wiki/Transport_Layer_Security>`_, and backup data can | |
22 | be encrypted on the client-side before sending, making it safer to back up data | |
23 | to targets that are not fully trusted. | |
0c56b0e6 | 24 | |
d2a8d597 DM |
25 | Architecture |
26 | ------------ | |
27 | ||
d2c7ef09 | 28 | Proxmox Backup Server uses a `client-server model`_. The server stores the |
092378ba | 29 | backup data and provides an API to create and manage datastores. With the |
32dc4c46 | 30 | API, it's also possible to manage disks and other server-side resources. |
d2a8d597 | 31 | |
717ce406 DW |
32 | The backup client uses this API to access the backed up data. You can use the |
33 | ``proxmox-backup-client`` command line tool to create and restore file backups. | |
34 | For QEMU_ and LXC_ within `Proxmox Virtual Environment`_, we deliver an | |
35 | integrated client. | |
d2a8d597 | 36 | |
d2c7ef09 | 37 | A single backup is allowed to contain several archives. For example, when you |
e1dc2d22 SI |
38 | backup a :term:`virtual machine<Virtual machine>`, each disk is stored as a |
39 | separate archive inside that backup. The VM configuration itself is stored as | |
40 | an extra file. This way, it's easy to access and restore only the important | |
41 | parts of the backup, without the need to scan the whole backup. | |
7ee2198e | 42 | |
0c56b0e6 | 43 | |
4f3db187 | 44 | Main Features |
6253aa50 | 45 | ------------- |
3147e56a | 46 | |
d2c7ef09 | 47 | :Support for Proxmox VE: The `Proxmox Virtual Environment`_ is fully |
e1dc2d22 SI |
48 | supported, and you can easily backup :term:`virtual machine<Virtual machine>`\ s and |
49 | :term:`container<Container>`\ s. | |
3147e56a | 50 | |
d2c7ef09 | 51 | :Performance: The whole software stack is written in :term:`Rust`, |
32dc4c46 | 52 | in order to provide high speed and memory efficiency. |
3147e56a | 53 | |
d2c7ef09 | 54 | :Deduplication: Periodic backups produce large amounts of duplicate |
32dc4c46 DW |
55 | data. The deduplication layer avoids redundancy and minimizes the storage |
56 | space used. | |
d2c7ef09 TL |
57 | |
58 | :Incremental backups: Changes between backups are typically low. Reading and | |
32dc4c46 | 59 | sending only the delta reduces the storage and network impact of backups. |
3147e56a | 60 | |
32dc4c46 DW |
61 | :Data Integrity: The built-in `SHA-256`_ checksum algorithm ensures accuracy and |
62 | consistency in your backups. | |
efd3e76b | 63 | |
4f3db187 AL |
64 | :Remote Sync: It is possible to efficiently synchronize data to remote |
65 | sites. Only deltas containing new data are transferred. | |
3147e56a | 66 | |
32dc4c46 | 67 | :Compression: The ultra-fast Zstandard_ compression is able to compress |
efd3e76b | 68 | several gigabytes of data per second. |
3147e56a | 69 | |
51f83548 TL |
70 | :Encryption: Backups can be encrypted on the client-side, using AES-256 GCM_. |
71 | This authenticated encryption (AE_) mode provides very high performance on | |
72 | modern hardware. In addition to client-side encryption, all data is | |
73 | transferred via a secure TLS connection. | |
2501c57c | 74 | |
717ce406 DW |
75 | :Tape backup: For long-term archiving of data, Proxmox Backup Server also |
76 | provides extensive support for backing up to tape and managing tape | |
77 | libraries. | |
78 | ||
32dc4c46 | 79 | :Web interface: Manage the Proxmox Backup Server with the integrated, web-based |
0c136efe | 80 | user interface. |
d2c7ef09 TL |
81 | |
82 | :Open Source: No secrets. Proxmox Backup Server is free and open-source | |
0c136efe | 83 | software. The source code is licensed under AGPL, v3. |
59b9c7ef | 84 | |
5f3b2330 | 85 | :No Limits: Proxmox Backup Server has no artificial limits for backup storage or |
654db565 TL |
86 | backup-clients. |
87 | ||
5847a6bd | 88 | :Enterprise Support: Proxmox Server Solutions GmbH offers enterprise support in |
717ce406 | 89 | the form of `Proxmox Backup Server Subscription Plans |
313e5e20 | 90 | <https://www.proxmox.com/en/proxmox-backup-server/pricing>`_. Users at every |
5847a6bd TL |
91 | subscription level get access to the Proxmox Backup :ref:`Enterprise |
92 | Repository <sysadmin_package_repos_enterprise>`. In addition, with a Basic, | |
93 | Standard or Premium subscription, users have access to the :ref:`Proxmox | |
94 | Customer Portal <get_help_enterprise_support>`. | |
59b9c7ef | 95 | |
2501c57c | 96 | |
d2c7ef09 TL |
97 | Reasons for Data Backup? |
98 | ------------------------ | |
6253aa50 | 99 | |
d2c7ef09 | 100 | The main purpose of a backup is to protect against data loss. Data loss can be |
32dc4c46 | 101 | caused by both faulty hardware and human error. |
6253aa50 | 102 | |
d2c7ef09 | 103 | A common mistake is to accidentally delete a file or folder which is still |
32dc4c46 DW |
104 | required. Virtualization can even amplify this problem, as deleting a whole |
105 | virtual machine can be as easy as pressing a single button. | |
6253aa50 | 106 | |
d2c7ef09 TL |
107 | For administrators, backups can serve as a useful toolkit for temporarily |
108 | storing data. For example, it is common practice to perform full backups before | |
109 | installing major software updates. If something goes wrong, you can easily | |
110 | restore the previous state. | |
6253aa50 | 111 | |
d2c7ef09 TL |
112 | Another reason for backups are legal requirements. Some data, especially |
113 | business records, must be kept in a safe place for several years by law, so | |
114 | that they can be accessed if required. | |
6253aa50 | 115 | |
d2c7ef09 TL |
116 | In general, data loss is very costly as it can severely damage your business. |
117 | Therefore, ensure that you perform regular backups and run restore tests. | |
6253aa50 DM |
118 | |
119 | ||
2501c57c DM |
120 | Software Stack |
121 | -------------- | |
122 | ||
7ba2c1c3 TL |
123 | Proxmox Backup Server consists of multiple components: |
124 | ||
3bbb70b3 | 125 | * A server-daemon providing, among other things, a RESTful API, super-fast |
7ba2c1c3 TL |
126 | asynchronous tasks, lightweight usage statistic collection, scheduling |
127 | events, strict separation of privileged and unprivileged execution | |
32dc4c46 DW |
128 | environments |
129 | * A JavaScript management web interface | |
130 | * A management CLI tool for the server (`proxmox-backup-manager`) | |
131 | * A client CLI tool (`proxmox-backup-client`) to access the server easily from | |
132 | any `Linux amd64` environment | |
7ba2c1c3 | 133 | |
84982908 TL |
134 | Aside from the web interface, most parts of Proxmox Backup Server are written in |
135 | the Rust programming language. | |
7ba2c1c3 TL |
136 | |
137 | "The Rust programming language helps you write faster, more reliable software. | |
138 | High-level ergonomics and low-level control are often at odds in programming | |
139 | language design; Rust challenges that conflict. Through balancing powerful | |
140 | technical capacity and a great developer experience, Rust gives you the option | |
141 | to control low-level details (such as memory usage) without all the hassle | |
142 | traditionally associated with such control." | |
143 | ||
144 | -- `The Rust Programming Language <https://doc.rust-lang.org/book/ch00-00-introduction.html>`_ | |
145 | ||
bb26843c | 146 | .. _get_help: |
e1dfcddc | 147 | |
56b814e3 TL |
148 | Getting Help |
149 | ------------ | |
150 | ||
5847a6bd TL |
151 | .. _get_help_enterprise_support: |
152 | ||
153 | Enterprise Support | |
154 | ~~~~~~~~~~~~~~~~~~ | |
155 | ||
156 | Users with a `Proxmox Backup Server Basic, Standard or Premium Subscription Plan | |
157 | <https://www.proxmox.com/en/proxmox-backup-server/pricing>`_ have access to the | |
e7e3d736 TL |
158 | `Proxmox Customer Portal <https://my.proxmox.com>`_. The customer portal |
159 | provides support with guaranteed response times from the Proxmox developers. | |
5847a6bd TL |
160 | For more information or for volume discounts, please contact office@proxmox.com. |
161 | ||
56b814e3 TL |
162 | Community Support Forum |
163 | ~~~~~~~~~~~~~~~~~~~~~~~ | |
164 | ||
165 | We always encourage our users to discuss and share their knowledge using the | |
166 | `Proxmox Community Forum`_. The forum is moderated by the Proxmox support team. | |
167 | The large user base is spread out all over the world. Needless to say that such | |
168 | a large forum is a great place to get information. | |
169 | ||
170 | Mailing Lists | |
171 | ~~~~~~~~~~~~~ | |
172 | ||
173 | Proxmox Backup Server is fully open-source and contributions are welcome! Here | |
174 | is the primary communication channel for developers: | |
4cda7603 | 175 | |
56b814e3 TL |
176 | :Mailing list for developers: `PBS Development List`_ |
177 | ||
178 | Bug Tracker | |
179 | ~~~~~~~~~~~ | |
180 | ||
181 | Proxmox runs a public bug tracker at `<https://bugzilla.proxmox.com>`_. If an | |
717ce406 | 182 | issue appears, file your report there. An issue can be a bug, as well as a |
56b814e3 TL |
183 | request for a new feature or enhancement. The bug tracker helps to keep track |
184 | of the issue and will send a notification once it has been solved. | |
185 | ||
2501c57c DM |
186 | License |
187 | ------- | |
188 | ||
96a7169e | 189 | |pbs-copyright| |
fdd471d5 DM |
190 | |
191 | This software is written by Proxmox Server Solutions GmbH <support@proxmox.com> | |
192 | ||
d2c7ef09 TL |
193 | Proxmox Backup Server is free and open source software: you can use it, |
194 | redistribute it, and/or modify it under the terms of the GNU Affero General | |
195 | Public License as published by the Free Software Foundation, either version 3 | |
196 | of the License, or (at your option) any later version. | |
fdd471d5 DM |
197 | |
198 | This program is distributed in the hope that it will be useful, but | |
199 | ``WITHOUT ANY WARRANTY``; without even the implied warranty of | |
200 | ``MERCHANTABILITY`` or ``FITNESS FOR A PARTICULAR PURPOSE``. See the GNU | |
201 | Affero General Public License for more details. | |
202 | ||
203 | You should have received a copy of the GNU Affero General Public License | |
204 | along with this program. If not, see AGPL3_. | |
205 | ||
6253aa50 | 206 | |
7e688b71 DM |
207 | History |
208 | ------- | |
209 | ||
6cd84960 DW |
210 | Backup is, and always has been, a central aspect of IT administration. |
211 | The need to recover from data loss is fundamental and only increases with | |
e1dfcddc DM |
212 | virtualization. |
213 | ||
6cd84960 DW |
214 | For this reason, we've been shipping a backup tool with Proxmox VE, from the |
215 | beginning. This tool is called ``vzdump`` and is able to make | |
e1dfcddc DM |
216 | consistent snapshots of running LXC containers and KVM virtual |
217 | machines. | |
218 | ||
6cd84960 | 219 | However, ``vzdump`` only allows for full backups. While this is fine |
e1dfcddc | 220 | for small backups, it becomes a burden for users with large VMs. Both |
6cd84960 DW |
221 | backup duration and storage usage are too high for this case, especially |
222 | for users who want to keep many backups of the same VMs. To solve these | |
223 | problems, we needed to offer deduplication and incremental backups. | |
e1dfcddc | 224 | |
6cd84960 | 225 | Back in October 2018, development started. We investigated |
e1dfcddc | 226 | several technologies and frameworks and finally decided to use |
6cd84960 DW |
227 | :term:`Rust` as the implementation language, in order to provide high speed and |
228 | memory efficiency. The 2018-edition of Rust seemed promising for our | |
229 | requirements. | |
230 | ||
231 | In July 2020, we released the first beta version of Proxmox Backup | |
232 | Server, followed by the first stable version in November 2020. With support for | |
717ce406 DW |
233 | encryption and incremental, fully deduplicated backups, Proxmox Backup offers a |
234 | secure environment, which significantly reduces network load and saves valuable | |
235 | storage space. |