docs: add more ...

[proxmox-backup.git] / docs / deployment-guide.rst

diff --git a/docs/deployment-guide.rst b/docs/deployment-guide.rst
index 9e78400d1d521734b33a538be73a7af1b8686bfc..b09c14f9d522b88e2e2e8f6b8a7852172359675f 100644 (file)
--- a/docs/deployment-guide.rst
+++ b/docs/deployment-guide.rst
@@ -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
+-------------------------