docs: add more ...
This commit is contained in:
Dietmar Maurer
parent
b423958d8e
commit
58ea88c8ab
@ -3,3 +3,91 @@ Deployment Guide
|
||||
|
||||
The deployment guide.
|
||||
|
||||
Backup Server Configuration
|
||||
---------------------------
|
||||
|
||||
The command line tool to configure and manage the server is called
|
||||
:command:`proxmox-backup-manager`.
|
||||
|
||||
|
||||
Datastore Configuration
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
A :term:`datastore` is a place to store backups. You can configure
|
||||
several datastores, but you need at least one of them. The datastore is identified by a simple `name` and point to a directory.
|
||||
|
||||
The following command creates a new datastore called ``store1`` on :file:`/backup/disk1/store1`
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# proxmox-backup-manager datastore create store1 /backup/disk1/store1
|
||||
|
||||
To list existing datastores use:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# proxmox-backup-manager datastore list
|
||||
store1 /backup/disk1/store1
|
||||
|
||||
Finally, it is also possible to remove the datastore configuration:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# proxmox-backup-manager datastore remove store1
|
||||
|
||||
.. note:: Above command removes the datastore configuration. It does
|
||||
not delete any data from the underlying directory.
|
||||
|
||||
|
||||
|
||||
Backup Client Configuration
|
||||
---------------------------
|
||||
|
||||
The command line client is called :command:`proxmox-backup-client`.
|
||||
|
||||
Respository Locations
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
The client uses a special repository notation to specify a datastore
|
||||
on the backup server.
|
||||
|
||||
[[username@]server:]datastore
|
||||
|
||||
If you do not specify a ``username`` the default is ``root@pam``. The
|
||||
default for server is to use the local host (``localhost``).
|
||||
|
||||
You can pass the repository by setting the ``--repository`` command
|
||||
line options, or by setting the ``PBS_REPOSITORY`` environment
|
||||
variable.
|
||||
|
||||
|
||||
Environment Variables
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
``PBS_REPOSITORY``
|
||||
The default backup repository.
|
||||
|
||||
``PBS_PASSWORD``
|
||||
When set, this value is used for the password required for the
|
||||
backup server.
|
||||
|
||||
``PBS_ENCRYPTION_PASSWORD``
|
||||
|
||||
When set, this value is used to access the secret encryption key (if
|
||||
protected by password).
|
||||
|
||||
|
||||
Creating Backups
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
Encryption
|
||||
^^^^^^^^^^
|
||||
|
||||
|
||||
Restoring Data
|
||||
~~~~~~~~~~~~~~
|
||||
|
||||
|
||||
`Proxmox VE`_ integration
|
||||
-------------------------
|
||||
|
||||
@ -5,7 +5,8 @@
|
||||
|
||||
.. |VERSION| replace:: 1.0
|
||||
.. |AUTHOR| replace:: Proxmox Support Team <support@proxmox.com>
|
||||
|
||||
.. |WEBSITE| replace:: https://www.proxmox.com
|
||||
.. |DOWNLOADS| replace:: https://www.proxmox.com/downloads
|
||||
|
||||
.. _Container: https://en.wikipedia.org/wiki/Container_(virtualization)
|
||||
.. _Zstandard: https://en.wikipedia.org/wiki/Zstandard
|
||||
@ -24,3 +25,7 @@
|
||||
.. _AE: https://en.wikipedia.org/wiki/Authenticated_encryption
|
||||
.. _GCM: https://en.wikipedia.org/wiki/Galois/Counter_Mode
|
||||
.. _AGPL3: https://www.gnu.org/licenses/agpl-3.0.en.html
|
||||
.. _Debian: https://www.debian.org/index.html
|
||||
.. _LVM: https://en.wikipedia.org/wiki/Logical_Volume_Manager_(Linux)
|
||||
.. _ZFS: https://en.wikipedia.org/wiki/ZFS
|
||||
.. _Proxmox VE: https://pve.proxmox.com
|
||||
|
||||
@ -13,6 +13,12 @@ Glossary
|
||||
A Container is an isolated user space. Programs runs directly on
|
||||
the hosts kernel, but with limited access to the host resources.
|
||||
|
||||
Datastore
|
||||
|
||||
A place to store backups. The current implemenation is
|
||||
file-system based, so this refers to a directory containing the
|
||||
backup data.
|
||||
|
||||
`Rust`_
|
||||
|
||||
Rust is a new, fast and memory-efficient system programming
|
||||
|
||||
@ -1,9 +1,132 @@
|
||||
Installation
|
||||
============
|
||||
|
||||
`Proxmox Backup`_ is split into a server part and a client part. The
|
||||
server part comes with it's own graphical installer, but we also
|
||||
ship Debian_ package repositories, so you can easily install those
|
||||
packages on any Debian_ based system.
|
||||
|
||||
.. include:: package-repositories.rst
|
||||
|
||||
|
||||
This aasd safd
|
||||
--------------
|
||||
Server installation
|
||||
-------------------
|
||||
|
||||
The backup server stores the actual backup data, but also provides a
|
||||
web based GUI for various management tasks, for example disk
|
||||
management.
|
||||
|
||||
.. note:: You always need a backup server. It is not possible to use
|
||||
`Proxmox Backup`_ without the server part.
|
||||
|
||||
The server is based on Debian, therefore the disk image (ISO file) provided
|
||||
by us includes a complete Debian system ("buster" for version 1.x) as
|
||||
well as all necessary backup packages.
|
||||
|
||||
Using the installer will guide you through the setup, allowing
|
||||
you to partition the local disk(s), apply basic system configurations
|
||||
(e.g. timezone, language, network) and install all required packages.
|
||||
Using the provided ISO will get you started in just a few minutes,
|
||||
that's why we recommend this method for new and existing users.
|
||||
|
||||
Alternatively, `Proxmox Backup`_ server can be installed on top of an
|
||||
existing Debian system.
|
||||
|
||||
Using the `Proxmox Backup`_ Installer
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
You can download the ISO from |DOWNLOADS|.
|
||||
It includes the following:
|
||||
|
||||
* Complete operating system (Debian Linux, 64-bit)
|
||||
|
||||
* The `Proxmox Backup`_ server installer, which partitions the local
|
||||
disk(s) with ext4, ext3, xfs or ZFS and installs the operating
|
||||
system.
|
||||
|
||||
* Our Linux kernel with ZFS support.
|
||||
|
||||
* Complete toolset for administering backups and all necessary
|
||||
resources
|
||||
|
||||
* Web based management interface for using the toolset
|
||||
|
||||
.. note:: During the installation process, the complete server
|
||||
is used by default and all existing data is removed.
|
||||
|
||||
|
||||
Install `Proxmox Backup`_ server on Debian
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Proxmox ships as a set of Debian packages, so you can install it on
|
||||
top of a standard Debian installation. After configuring the
|
||||
:ref:`sysadmin_package_repositories`, you need to run:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get update
|
||||
# apt-get install proxmox-backup-server
|
||||
|
||||
Above code keeps the current (Debian) kernel and installs a minimal
|
||||
set of required packages.
|
||||
|
||||
If you want to install the same set of packages as the installer
|
||||
does, please use the following:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get update
|
||||
# apt-get install proxmox-backup
|
||||
|
||||
This installs all required packages, the Proxmox kernel with ZFS_
|
||||
support, and a set of commonly useful packages.
|
||||
|
||||
Installing on top of an existing Debian_ installation looks easy, but
|
||||
it presumes that you have correctly installed the base system, and you
|
||||
know how you want to configure and use the local storage. Network
|
||||
configuration is also completely up to you.
|
||||
|
||||
In general, this is not trivial, especially when you use LVM_ or
|
||||
ZFS_.
|
||||
|
||||
Install Proxmox Backup server on `Proxmox VE`_
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
After configuring the
|
||||
:ref:`sysadmin_package_repositories`, you need to run:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get update
|
||||
# apt-get install proxmox-backup-server
|
||||
|
||||
.. caution:: Installing the backup server directly on the hypervisor
|
||||
is not recommended. It is more secure to use a separate physical
|
||||
server to store backups. If the hypervisor server fails, you can
|
||||
still access your backups.
|
||||
|
||||
Client installation
|
||||
-------------------
|
||||
|
||||
Install `Proxmox Backup`_ client on Debian
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Proxmox ships as a set of Debian packages, so you can install it on
|
||||
top of a standard Debian installation. After configuring the
|
||||
:ref:`sysadmin_package_repositories`, you need to run:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
# apt-get update
|
||||
# apt-get install proxmox-backup-client
|
||||
|
||||
|
||||
Installing from source
|
||||
~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
FIXME
|
||||
|
||||
Installing statically linked binary
|
||||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
FIXME
|
||||
|
||||
@ -1,3 +1,5 @@
|
||||
.. _sysadmin_package_repositories:
|
||||
|
||||
Debian Package Repositories
|
||||
---------------------------
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user