]> git.proxmox.com Git - proxmox-backup.git/commitdiff
docs: rename deployment-guide.rst -> administration-guide.rst
authorDietmar Maurer <dietmar@proxmox.com>
Fri, 15 Nov 2019 11:34:50 +0000 (12:34 +0100)
committerDietmar Maurer <dietmar@proxmox.com>
Fri, 15 Nov 2019 11:35:31 +0000 (12:35 +0100)
and join with admin-guide.rst

docs/admin-guide.rst [deleted file]
docs/administration-guide.rst [new file with mode: 0644]
docs/deployment-guide.rst [deleted file]
docs/index.rst

diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
deleted file mode 100644 (file)
index 4d56aa2..0000000
+++ /dev/null
@@ -1,10 +0,0 @@
-Admin Guide
-===========
-
-The administration guide.
-
-
-.. include:: command-line-tools.rst
-
-.. include:: services.rst
-
diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst
new file mode 100644 (file)
index 0000000..f89c888
--- /dev/null
@@ -0,0 +1,98 @@
+Administration Guide
+====================
+
+The administartion guide.
+
+Backup Server Management
+------------------------
+
+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 usage
+-------------------
+
+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
+-------------------------
+
+
+.. include:: command-line-tools.rst
+
+.. include:: services.rst
diff --git a/docs/deployment-guide.rst b/docs/deployment-guide.rst
deleted file mode 100644 (file)
index b09c14f..0000000
+++ /dev/null
@@ -1,93 +0,0 @@
-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
--------------------------
index 78303c43d2ebacd348d32ad9fcea751a78dc6774..1a08324103673b592f881f7b1a7f6b625fd81927 100644 (file)
@@ -18,8 +18,7 @@ Documentation License".
 
    introduction.rst
    installation.rst
-   deployment-guide.rst
-   admin-guide.rst
+   administration-guide.rst
  
 .. raw:: latex