From ac456d85e8c316a165d5ded5dbac74378e51a972 Mon Sep 17 00:00:00 2001 From: Dietmar Maurer Date: Wed, 4 Dec 2019 10:47:41 +0100 Subject: [PATCH] docs/administration-guide.rst: describe login/logout --- docs/administration-guide.rst | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index f31ae832..bf75c129 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -371,6 +371,30 @@ to use the interactive recovery shell. .. todo:: Explain interactive restore +Login and Logout +~~~~~~~~~~~~~~~~ + +The client tool prompts you to enter the logon password as soon as you +want to access the backup server. The server checks your credentials +and responds with a ticket that is valid for two hours. The client +tool automatically stores that ticket and use it for further requests +to this server. + +You can also manually trigger this login/logout using the login and +logout commands: + +.. code-block:: console + + # proxmox-backup-client login + Password: ********** + +To remove the ticket, simply issue a logout: + +.. code-block:: console + + # proxmox-backup-client logout + + .. _pve-integration: `Proxmox VE`_ integration