2019-02-27 17:35:05 +00:00
|
|
|
Introduction
|
|
|
|
|
============
|
|
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
This documentation is written in :term:`reStructuredText` and formatted with
|
|
|
|
|
:term:`Sphinx`.
|
2019-02-28 18:09:55 +00:00
|
|
|
|
2019-11-16 10:43:14 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
What is Proxmox Backup Server
|
|
|
|
|
-----------------------------
|
2019-02-27 17:35:05 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
Proxmox Backup Server is an enterprise-class client-server backup software that
|
|
|
|
|
backups :term:`virtual machine`\ s, :term:`container`\ s, and physical hosts.
|
|
|
|
|
It is specially optimized for the `Proxmox Virtual Environment`_ platform and
|
|
|
|
|
allows you to backup your data securely, even between remote sites, providing
|
|
|
|
|
easy management with a web-based user interface.
|
2019-11-16 10:43:14 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
Proxmox Backup Server supports deduplication, compression, and authenticated
|
|
|
|
|
encryption (AE_). Using :term:`Rust` as implementation language guarantees high
|
2019-11-16 10:43:14 +00:00
|
|
|
performance, low resource usage, and a safe, high quality code base.
|
|
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
It features strong encryption done on the client side. Thus, it's possible to
|
|
|
|
|
backup data to not fully trusted targets.
|
2019-11-16 10:43:14 +00:00
|
|
|
|
2019-03-02 16:51:18 +00:00
|
|
|
|
2019-11-11 12:26:08 +00:00
|
|
|
Architecture
|
|
|
|
|
------------
|
|
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
Proxmox Backup Server uses a `client-server model`_. The server stores the
|
|
|
|
|
backup data and provides an API to create backups and restore data. With the
|
|
|
|
|
API it's also possible to manage disks and other server side resources.
|
2019-11-11 12:26:08 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
The backup client uses this API to access the backed up data. With the command
|
|
|
|
|
line tool ``proxmox-backup-client`` you can create backups and restore data.
|
|
|
|
|
For QEMU_ with `Proxmox Virtual Environment`_ we deliver an integrated client.
|
2019-11-11 12:26:08 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
A single backup is allowed to contain several archives. For example, when you
|
|
|
|
|
backup a :term:`virtual machine`, each disk is stored as a separate archive
|
|
|
|
|
inside that backup. The VM configuration itself is stored as an extra file.
|
|
|
|
|
This way, it is easy to access and restore only important parts of the backup
|
|
|
|
|
without the need to scan the whole backup.
|
2019-11-17 07:47:22 +00:00
|
|
|
|
2019-03-02 16:51:18 +00:00
|
|
|
|
2020-04-14 15:12:47 +00:00
|
|
|
Main Features
|
2019-03-02 17:08:00 +00:00
|
|
|
-------------
|
2019-03-02 09:31:32 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
:Support for Proxmox VE: The `Proxmox Virtual Environment`_ is fully
|
|
|
|
|
supported and you can easily backup :term:`virtual machine`\ s and
|
2019-03-02 09:31:32 +00:00
|
|
|
:term:`container`\ s.
|
|
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
:Performance: The whole software stack is written in :term:`Rust`,
|
|
|
|
|
to provide high speed and memory efficiency.
|
2019-03-02 09:31:32 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
:Deduplication: Periodic backups produce large amounts of duplicate
|
|
|
|
|
data. The deduplication layer avoids redundancy and minimizes the used
|
|
|
|
|
storage space.
|
|
|
|
|
|
|
|
|
|
:Incremental backups: Changes between backups are typically low. Reading and
|
|
|
|
|
sending only the delta reduces storage and network impact of backups.
|
2019-03-02 09:31:32 +00:00
|
|
|
|
2019-03-02 15:56:01 +00:00
|
|
|
:Data Integrity: The built in `SHA-256`_ checksum algorithm assures the
|
2019-12-18 15:56:40 +00:00
|
|
|
accuracy and consistency of your backups.
|
2019-03-02 15:56:01 +00:00
|
|
|
|
2020-04-14 15:12:47 +00:00
|
|
|
:Remote Sync: It is possible to efficiently synchronize data to remote
|
|
|
|
|
sites. Only deltas containing new data are transferred.
|
2019-03-02 09:31:32 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
:Compression: The ultra fast Zstandard_ compression is able to compress
|
2019-03-02 15:56:01 +00:00
|
|
|
several gigabytes of data per second.
|
2019-03-02 09:31:32 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
:Encryption: Backups can be encrypted on the client-side using AES-256 in
|
2019-11-11 18:07:03 +00:00
|
|
|
GCM_ mode. This authenticated encryption mode (AE_) provides very
|
|
|
|
|
high performance on modern hardware.
|
|
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
:Web interface: Manage Proxmox backups with the integrated web-based user
|
|
|
|
|
interface.
|
|
|
|
|
|
|
|
|
|
:Open Source: No secrets. Proxmox Backup Server is free and open-source
|
|
|
|
|
software. The source code is licensed under AGPL, v3.
|
2019-03-02 17:23:48 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
:Support: Enterprise support is available from `Proxmox`_.
|
2019-03-02 17:23:48 +00:00
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
Reasons for Data Backup?
|
|
|
|
|
------------------------
|
2019-03-02 17:08:00 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
The main purpose of a backup is to protect against data loss. Data loss can be
|
|
|
|
|
caused by faulty hardware but also by human error.
|
2019-03-02 17:08:00 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
A common mistake is to accidentally delete a file or folder which is still
|
|
|
|
|
required. Virtualization can even amplify this problem; it easily happens that
|
|
|
|
|
a whole virtual machine is deleted by just pressing a single button.
|
2019-03-02 17:08:00 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
For administrators, backups can serve as a useful toolkit for temporarily
|
|
|
|
|
storing data. For example, it is common practice to perform full backups before
|
|
|
|
|
installing major software updates. If something goes wrong, you can easily
|
|
|
|
|
restore the previous state.
|
2019-03-02 17:08:00 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
Another reason for backups are legal requirements. Some data, especially
|
|
|
|
|
business records, must be kept in a safe place for several years by law, so
|
|
|
|
|
that they can be accessed if required.
|
2019-03-02 17:08:00 +00:00
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
In general, data loss is very costly as it can severely damage your business.
|
|
|
|
|
Therefore, ensure that you perform regular backups and run restore tests.
|
2019-03-02 17:08:00 +00:00
|
|
|
|
|
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
Software Stack
|
|
|
|
|
--------------
|
|
|
|
|
|
2020-01-29 14:14:37 +00:00
|
|
|
.. todo:: Eplain why we use Rust (and Flutter)
|
2019-11-16 10:50:56 +00:00
|
|
|
|
2019-11-11 18:07:03 +00:00
|
|
|
|
|
|
|
|
License
|
|
|
|
|
-------
|
|
|
|
|
|
2020-07-04 15:57:47 +00:00
|
|
|
Copyright (C) 2019-2020 Proxmox Server Solutions GmbH
|
2019-11-11 18:21:27 +00:00
|
|
|
|
|
|
|
|
This software is written by Proxmox Server Solutions GmbH <support@proxmox.com>
|
|
|
|
|
|
2020-07-03 16:58:14 +00:00
|
|
|
Proxmox Backup Server is free and open source software: you can use it,
|
|
|
|
|
redistribute it, and/or modify it under the terms of the GNU Affero General
|
|
|
|
|
Public License as published by the Free Software Foundation, either version 3
|
|
|
|
|
of the License, or (at your option) any later version.
|
2019-11-11 18:21:27 +00:00
|
|
|
|
|
|
|
|
This program is distributed in the hope that it will be useful, but
|
|
|
|
|
``WITHOUT ANY WARRANTY``; without even the implied warranty of
|
|
|
|
|
``MERCHANTABILITY`` or ``FITNESS FOR A PARTICULAR PURPOSE``. See the GNU
|
|
|
|
|
Affero General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
|
|
|
along with this program. If not, see AGPL3_.
|
|
|
|
|
|
2019-03-02 17:08:00 +00:00
|
|
|
|
2019-02-27 17:35:05 +00:00
|
|
|
History
|
|
|
|
|
-------
|
|
|
|
|
|
2019-11-16 10:50:56 +00:00
|
|
|
.. todo:: Add development History of the product
|
|
|
|
|
|
