tyler
/
proxmox-backup
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
proxmox-backup/docs/introduction.rst

133 lines
4.5 KiB
ReStructuredText
Raw Normal View History

docs: improve ducument structure
2019-02-27 17:35:05 +00:00
Introduction
============
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
This documentation is written in :term:`reStructuredText` and formatted with :term:`Sphinx`.
docs: add glossary.rst
2019-02-28 18:09:55 +00:00
docs: improve introduction.rst
2019-11-16 10:43:14 +00:00
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
What is Proxmox Backup
----------------------
docs: improve ducument structure
2019-02-27 17:35:05 +00:00
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
Proxmox Backup is an enterprise class client-server backup software,
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
specially optimized for the `Proxmox Virtual Environment`_ to backup
docs: improve introduction.rst
2019-11-16 10:43:14 +00:00
:term:`virtual machine`\ s and :term:`container`\ s. It is also
possible to backup physical hosts.
It supports deduplication, compression and authenticated encryption
docs: s/RUST/Rust/ Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-29 14:14:37 +00:00
(AE_). Using :term:`Rust` as implementation language guarantees high
docs: improve introduction.rst
2019-11-16 10:43:14 +00:00
performance, low resource usage, and a safe, high quality code base.
Encryption is done at the client side. This makes backups to not fully
trusted targets possible.
docs: improve section "Why Backup"
2019-03-02 16:51:18 +00:00
introduction.rst: Add short Architecture section
2019-11-11 12:26:08 +00:00
Architecture
------------
Proxmox Backup uses a `Client-server model`_. The server is
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
responsible to store the backup data and provides an API to create
backups and restore data. It is possible to manage disks and
docs: improve introduction.rst
2019-11-16 10:43:14 +00:00
other server side resources using this API.
introduction.rst: Add short Architecture section
2019-11-11 12:26:08 +00:00
A backup client uses this API to access the backed up data,
i.e. ``proxmox-backup-client`` is a command line tool to create
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
backups and restore data. We deliver an integrated client for
introduction.rst: Add short Architecture section
2019-11-11 12:26:08 +00:00
QEMU_ with `Proxmox Virtual Environment`_.
docs/introduction.rst: improve section Architecture
2019-11-17 07:47:22 +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 also gets an
extra file. This way, it is easy to access and restore important parts
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
of the backup without having to scan the whole backup.
docs/introduction.rst: improve section Architecture
2019-11-17 07:47:22 +00:00
docs: improve section "Why Backup"
2019-03-02 16:51:18 +00:00
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
Main Features
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
-------------
docs: add epilog.rst to define common things.
2019-03-02 09:31:32 +00:00
:Proxmox VE: The `Proxmox Virtual Environment`_ is fully
supported. You can backup :term:`virtual machine`\ s and
:term:`container`\ s.
:GUI: We provide a graphical, web based user interface.
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
:Deduplication: Incremental backups produce large amounts of duplicate
docs: add epilog.rst to define common things.
2019-03-02 09:31:32 +00:00
data. The deduplication layer removes that redundancy and makes
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
incremental backups small and space efficient.
docs: add epilog.rst to define common things.
2019-03-02 09:31:32 +00:00
docs: add more features
2019-03-02 15:56:01 +00:00
:Data Integrity: The built in `SHA-256`_ checksum algorithm assures the
docs: fix typo in introduction.rst Signed-off-by: Oguz Bektas <o.bektas@proxmox.com>
2019-12-18 15:56:40 +00:00
accuracy and consistency of your backups.
docs: add more features
2019-03-02 15:56:01 +00:00
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
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.
docs: add epilog.rst to define common things.
2019-03-02 09:31:32 +00:00
:Performance: The whole software stack is written in :term:`Rust`,
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
to provide high speed and memory efficiency.
docs: add epilog.rst to define common things.
2019-03-02 09:31:32 +00:00
docs/introduction.rst: add feature Encryption, replace LZ4 with Zstandard
2019-11-11 18:07:03 +00:00
:Compression: Ultra fast Zstandard_ compression is able to compress
docs: add more features
2019-03-02 15:56:01 +00:00
several gigabytes of data per second.
docs: add epilog.rst to define common things.
2019-03-02 09:31:32 +00:00
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
:Encryption: Backups can be encrypted client-side using AES-256 in
docs/introduction.rst: add feature Encryption, replace LZ4 with Zstandard
2019-11-11 18:07:03 +00:00
GCM_ mode. This authenticated encryption mode (AE_) provides very
high performance on modern hardware.
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
:Open Source: No secrets. You have access to all the source code.
docs: add support link
2019-03-02 17:23:48 +00:00
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
:Support: Commercial support options are available from `Proxmox`_.
docs: add support link
2019-03-02 17:23:48 +00:00
docs/introduction.rst: add feature Encryption, replace LZ4 with Zstandard
2019-11-11 18:07:03 +00:00
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
Why Backup?
-----------
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
The primary purpose of a backup is to protect against data loss. Data
loss can be caused by faulty hardware, but also by human error.
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
A common mistake is to delete a file or folder which is still
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
required. Virtualization can amplify this problem. It is now
easy to delete a whole virtual machine by pressing a single button.
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
Backups can serve as a toolkit for administrators to temporarily
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
store data. For example, it is common practice to perform full backups
before installing major software updates. If something goes wrong, you
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
can restore the previous state.
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
Another reason for backups are legal requirements. Some data must be
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
kept in a safe place for several years by law, so that it can be accessed if
required.
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
docs/introduction.rst: improve "Why Backup" section.
2019-12-03 07:18:52 +00:00
Data loss can be very costly as it can severely restrict your
Docu: first proof reading This is a first proof reading of the currently existing documentation. fixes (hopefully all): * spelling * grammar Tries to increase readabilty and ease of understanding by simplifying and restructing some sentences and paragraphs. Filler words which add to the cognitive load but don't add anything are removed (most notably `also`).
2020-04-14 15:12:47 +00:00
business. Therefore, make sure that you perform a backup regularly
docs/introduction.rst: improve "Why Backup" section.
2019-12-03 07:18:52 +00:00
and run restore tests.
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
docs/introduction.rst: add feature Encryption, replace LZ4 with Zstandard
2019-11-11 18:07:03 +00:00
Software Stack
--------------
docs: s/RUST/Rust/ Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
2020-01-29 14:14:37 +00:00
.. todo:: Eplain why we use Rust (and Flutter)
docs/introduction.rst: add todo items
2019-11-16 10:50:56 +00:00
docs/introduction.rst: add feature Encryption, replace LZ4 with Zstandard
2019-11-11 18:07:03 +00:00
License
-------
docs/introduction.rst: Add License Section (AGPL3)
2019-11-11 18:21:27 +00:00
Copyright (C) 2019 Proxmox Server Solutions GmbH
This software is written by Proxmox Server Solutions GmbH <support@proxmox.com>
Proxmox Backup is free software: you can 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.
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_.
docs: add "What is Proxmox Backup"
2019-03-02 17:08:00 +00:00
docs: improve ducument structure
2019-02-27 17:35:05 +00:00
History
-------
docs/introduction.rst: add todo items
2019-11-16 10:50:56 +00:00
.. todo:: Add development History of the product