docs/introduction.rst

   1 Introduction
   2 ============
   3
   4 This documentationm is written in :term:`reStructuredText` and formatted with :term:`Sphinx`.
   5
   6
   7 What is Proxmox Backup
   8 ----------------------
   9
  10 Proxmox Backup is an enterprise class client-server backup software,
  11 specially optimized for `Proxmox Virtual Environment`_ to backup
  12 :term:`virtual machine`\ s and :term:`container`\ s. It is also
  13 possible to backup physical hosts.
  14
  15 It supports deduplication, compression and authenticated encryption
  16 (AE_). Using RUST_ as implementation language guarantees high
  17 performance, low resource usage, and a safe, high quality code base.
  18
  19 Encryption is done at the client side. This makes backups to not fully
  20 trusted targets possible.
  21
  22
  23 Architecture
  24 ------------
  25
  26 Proxmox Backup uses a `Client-server model`_. The server is
  27 responsible to store the backup data, and provides an API to create
  28 backups and restore data. It is also possible to manage disks and
  29 other server side resources using this API.
  30
  31 A backup client uses this API to access the backed up data,
  32 i.e. ``proxmox-backup-client`` is a command line tool to create
  33 backups and restore data. We also deliver an integrated client for
  34 QEMU_ with `Proxmox Virtual Environment`_.
  35
  36 A single backup is allowed to contain several archives. For example,
  37 when you backup a :term:`virtual machine`, each disk is stored as a
  38 separate archive inside that backup. The VM configuration also gets an
  39 extra file. This way, it is easy to access and restore important parts
  40 of the backup, without having to scan the whole backup.
  41
  42
  43 Main features
  44 -------------
  45
  46 :Proxmox VE: The `Proxmox Virtual Environment`_ is fully
  47    supported. You can backup :term:`virtual machine`\ s and
  48    :term:`container`\ s.
  49
  50 :GUI: We provide a graphical, web based user interface.
  51
  52 :Deduplication: Incremental backup produces large amounts of duplicate
  53    data. The deduplication layer removes that redundancy and makes
  54    inkremental backup small and space efficient.
  55
  56 :Data Integrity: The built in `SHA-256`_ checksum algorithm assures the
  57    accuray and consistency of your backups.
  58
  59 :Remote Sync: It is possible to efficently synchronize data to remote
  60    sites. Only deltas containing new data are transfered.
  61
  62 :Performance: The whole software stack is written in :term:`Rust`,
  63    which provides high speed and memory efficiency.
  64
  65 :Compression: Ultra fast Zstandard_ compression is able to compress
  66    several gigabytes of data per second.
  67
  68 :Encryption: Backups can be encrypted at client side using AES-256 in
  69    GCM_ mode. This authenticated encryption mode (AE_) provides very
  70    high performance on modern hardware.
  71
  72 :Open Source: No secrets. You have access to the whole source tree.
  73
  74 :Support: Commercial support options available from `Proxmox`_.
  75
  76
  77 Why Backup?
  78 -----------
  79
  80 The primary purpose of backup is to protect against data loss. Data
  81 loss can happen because of faulty hardware, but also by human errors.
  82
  83 A common mistake is to delete a file or folder which is still
  84 required. Virtualization can amplify this problem, because it is now
  85 easy to delete a whole virtual machine by a single button press.
  86
  87 Backups can also serve as a toolkit for administrators to temporarily
  88 store data. For example, it is common practice to perform full backups
  89 before installing major software updates. If something goes wrong, you
  90 can just restore the previous state.
  91
  92 Another reason for backups are legal requirements. Some data must be
  93 kept in a safe place for several years so that you can access it if
  94 required by law.
  95
  96
  97 - value of data, importance for your business, legal regulations
  98
  99 - restore tests. to make sure backup/restore works
 100
 101
 102 Software Stack
 103 --------------
 104
 105 .. todo:: Eplain why we use RUST (and Flutter)
 106
 107
 108 License
 109 -------
 110
 111 Copyright (C) 2019 Proxmox Server Solutions GmbH
 112
 113 This software is written by Proxmox Server Solutions GmbH <support@proxmox.com>
 114
 115 Proxmox Backup is free software: you can redistribute it and/or modify
 116 it under the terms of the GNU Affero General Public License as
 117 published by the Free Software Foundation, either version 3 of the
 118 License, or (at your option) any later version.
 119
 120 This program is distributed in the hope that it will be useful, but
 121 ``WITHOUT ANY WARRANTY``; without even the implied warranty of
 122 ``MERCHANTABILITY`` or ``FITNESS FOR A PARTICULAR PURPOSE``.  See the GNU
 123 Affero General Public License for more details.
 124
 125 You should have received a copy of the GNU Affero General Public License
 126 along with this program.  If not, see AGPL3_.
 127
 128
 129 History
 130 -------
 131
 132 .. todo:: Add development History of the product
 133