all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Dylan Whyte <d.whyte@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH docs 4/6] User Management: Add screenshots and explanation
Date: Mon,  7 Sep 2020 17:21:10 +0200	[thread overview]
Message-ID: <20200907152112.14057-5-d.whyte@proxmox.com> (raw)
In-Reply-To: <20200907152112.14057-1-d.whyte@proxmox.com>

Add screenshots for user management section in web
interface and explain how to carry out relevant tasks
using it.

Signed-off-by: Dylan Whyte <d.whyte@proxmox.com>
---
 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





  parent reply	other threads:[~2020-09-07 15:21 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-07 15:21 [pbs-devel] [PATCH docs 0/6] Add GUI screenshots and explain Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 1/6] Add screenshots of web interface Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 2/6] Disk Management: Add screenshots and explanation Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 3/6] Datastore Config: add " Dylan Whyte
2020-09-07 15:21 ` Dylan Whyte [this message]
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 5/6] Network Config: Add " Dylan Whyte
2020-09-07 15:21 ` [pbs-devel] [PATCH docs 6/6] Sync Jobs: add " Dylan Whyte
2020-09-08  4:20 ` [pbs-devel] applied: [PATCH docs 0/6] Add GUI screenshots and explain Dietmar Maurer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20200907152112.14057-5-d.whyte@proxmox.com \
    --to=d.whyte@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal