From: Lukas Wagner <l.wagner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox-backup] docs: ldap: break long lines/remove trailing whitespace
Date: Mon, 13 Feb 2023 15:24:21 +0100 [thread overview]
Message-ID: <20230213142421.899457-1-l.wagner@proxmox.com> (raw)
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
---
docs/user-management.rst | 53 ++++++++++++++++++++++++----------------
1 file changed, 32 insertions(+), 21 deletions(-)
diff --git a/docs/user-management.rst b/docs/user-management.rst
index faaf183d..5885f1c1 100644
--- a/docs/user-management.rst
+++ b/docs/user-management.rst
@@ -572,12 +572,12 @@ Authentication Realms
LDAP
~~~~
-Proxmox Backup Server can utilize external LDAP servers for user authentication. To achieve this,
-a realm of the type ``ldap`` has to be configured.
+Proxmox Backup Server can utilize external LDAP servers for user authentication.
+To achieve this, a realm of the type ``ldap`` has to be configured.
-In LDAP, users are uniquely identified
-by their domain (``dn``). For instance, in the following LDIF dataset, the user ``user1`` has the
-unique domain ``uid=user1,ou=People,dc=ldap-test,dc=com``:
+In LDAP, users are uniquely identified by their domain (``dn``). For instance,
+in the following LDIF dataset, the user ``user1`` has the unique domain
+``uid=user1,ou=People,dc=ldap-test,dc=com``:
.. code-block:: console
@@ -593,28 +593,39 @@ unique domain ``uid=user1,ou=People,dc=ldap-test,dc=com``:
sn: Testers
description: This is the first test user.
-In in similar manner, Proxmox Backup Server uses user identifiers (``userid``) to uniquely identify users.
-Thus, it is necessary to establish a mapping between PBS's ``userid`` and LDAP's ``dn``.
-This mapping is established by the ``user-attr`` configuration parameter - it contains the name of the
-LDAP attribute containing a valid PBS user identifier.
+In in similar manner, Proxmox Backup Server uses user identifiers (``userid``)
+to uniquely identify users. Thus, it is necessary to establish a mapping
+between PBS's ``userid`` and LDAP's ``dn``. This mapping is established by
+the ``user-attr`` configuration parameter - it contains the name of the LDAP
+attribute containing a valid PBS user identifier.
-For the example above, setting ``user-attr`` to ``uid`` will have the effect that the user ``user1@<realm-name>`` will be mapped to the LDAP entity
-``uid=user1,ou=People,dc=ldap-test,dc=com``. On user login, PBS will perform a `subtree search` under the configured Base Domain (``base-dn``) to query
-the user's ``dn``. Once the ``dn`` is known, an LDAP bind operation is performed to authenticate the user against the LDAP server.
+For the example above, setting ``user-attr`` to ``uid`` will have the effect
+that the user ``user1@<realm-name>`` will be mapped to the LDAP entity
+``uid=user1,ou=People,dc=ldap-test,dc=com``. On user login, PBS will perform
+a `subtree search` under the configured Base Domain (``base-dn``) to query
+the user's ``dn``. Once the ``dn`` is known, an LDAP bind operation is performed
+to authenticate the user against the LDAP server.
-As not all LDAP servers allow `anonymous` search operations, it is possible to configure a bind domain (``bind-dn``) and a bind password (``password``).
-If set, PBS will bind to the LDAP server using these credentials before performing any search operations.
+As not all LDAP servers allow `anonymous` search operations, it is possible to
+configure a bind domain (``bind-dn``) and a bind password (``password``).
+If set, PBS will bind to the LDAP server using these credentials before
+performing any search operations.
A full list of all configuration parameters can be found at :ref:`domains.cfg`.
-.. note:: In order to allow a particular user to authenticate using the LDAP server, you must also add them as a user of that realm in Proxmox Backup Server.
- This can be carried out automatically with syncing.
+.. note:: In order to allow a particular user to authenticate using the LDAP
+ server, you must also add them as a user of that realm in Proxmox Backup
+ Server. This can be carried out automatically with syncing.
User Synchronization in LDAP realms
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-It is possible to automatically sync users for LDAP-based realms, rather than having to add them to Proxmox VE manually.
-Synchronization options can be set in the LDAP realm configuration dialog window in the GUI and via the ``proxmox-backup-manager ldap create/update`` command.
-User synchronization can started in the GUI at Configuration > Access Control > Realms by selecting a realm and pressing the `Sync` button. In the sync dialog,
-some of the default options set in the realm configuration can be overridden. Alternatively,
-user synchronization can also be started via the ``proxmox-backup-manager ldap sync`` command.
\ No newline at end of file
+It is possible to automatically sync users for LDAP-based realms, rather than
+having to add them to Proxmox VE manually. Synchronization options can be set
+in the LDAP realm configuration dialog window in the GUI and via the
+``proxmox-backup-manager ldap create/update`` command.
+User synchronization can started in the GUI at
+Configuration > Access Control > Realms by selecting a realm and pressing the
+`Sync` button. In the sync dialog, some of the default options set in the realm
+configuration can be overridden. Alternatively, user synchronization can also
+be started via the ``proxmox-backup-manager ldap sync`` command.
--
2.30.2
next reply other threads:[~2023-02-13 14:24 UTC|newest]
Thread overview: 2+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-02-13 14:24 Lukas Wagner [this message]
2023-03-27 12:22 ` [pbs-devel] applied: " Wolfgang Bumiller
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=20230213142421.899457-1-l.wagner@proxmox.com \
--to=l.wagner@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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox