From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id EBC6A61AC5 for ; Mon, 7 Sep 2020 17:21:29 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E9869C93A for ; Mon, 7 Sep 2020 17:21:29 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 23A67CCE2 for ; Mon, 7 Sep 2020 17:21:27 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id DFBE844A8C for ; Mon, 7 Sep 2020 17:21:26 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Mon, 7 Sep 2020 17:21:10 +0200 Message-Id: <20200907152112.14057-5-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com> References: <20200907152112.14057-1-d.whyte@proxmox.com> MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.013 Adjusted score from AWL reputation of From: address KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH docs 4/6] User Management: Add screenshots and explanation X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Mon, 07 Sep 2020 15:21:30 -0000 Add screenshots for user management section in web interface and explain how to carry out relevant tasks using it. Signed-off-by: Dylan Whyte --- docs/administration-guide.rst | 36 ++++++++++++++++++++++++----------- 1 file changed, 25 insertions(+), 11 deletions(-) diff --git a/docs/administration-guide.rst b/docs/administration-guide.rst index 58c18f1c..96803c65 100644 --- a/docs/administration-guide.rst +++ b/docs/administration-guide.rst @@ -381,6 +381,11 @@ directories will store the chunked data after a backup operation has been execut User Management ~~~~~~~~~~~~~~~ +.. image:: images/screenshots/pbs-gui-user-management.png + :width: 230 + :align: right + :alt: User management + Proxmox Backup Server supports several authentication realms, and you need to choose the realm when you add a new user. Possible realms are: @@ -405,19 +410,22 @@ users: │ root@pam │ 1 │ │ │ │ │ Superuser │ └─────────────┴────────┴────────┴───────────┴──────────┴────────────────┴────────────────────┘ -The superuser has full administration rights on everything, so you -normally want to add other users with less privileges: - -.. code-block:: console +.. image:: images/screenshots/pbs-gui-user-management-add-user.png + :width: 230 + :align: right + :alt: Add a new user - # proxmox-backup-manager user create john@pbs --email john@example.com +The superuser has full administration rights on everything, so you +normally want to add other users with less privileges. You can create a new +user with the ``user create`` subcommand or through the web interface, under +**Configuration -> User Management**. The ``create`` subcommand lets you specify +many options like ``--email`` or ``--password``. You can update or change any +user properties using the ``update`` subcommand later (**Edit** in the GUI): -The create command lets you specify many options like ``--email`` or -``--password``. You can update or change any of them using the -update command later: .. code-block:: console + # proxmox-backup-manager user create john@pbs --email john@example.com # proxmox-backup-manager user update john@pbs --firstname John --lastname Smith # proxmox-backup-manager user update john@pbs --comment "An example user." @@ -495,9 +503,15 @@ following roles exist: **RemoteSyncOperator** Is allowed to read data from a remote. -You can use the ``acl`` subcommand to manage and monitor user permissions. For -example, the command below will add the user ``john@pbs`` as a -**DatastoreAdmin** for the data store ``store1``, located at ``/backup/disk1/store1``: + :width: 230 + :align: right + :alt: Add permissions for user + +You can manage datastore permissions from **Configuration -> Permissions** in +the web interface. Likewise, you can use the ``acl`` subcommand to manage and +monitor user permissions from the command line. For example, the command below +will add the user ``john@pbs`` as a **DatastoreAdmin** for the datastore +``store1``, located at ``/backup/disk1/store1``: .. code-block:: console -- 2.20.1