From ee165e3647db8cdb40a5ff3199cf967b5de46f3d Mon Sep 17 00:00:00 2001 From: Peter van Dijk Date: Fri, 19 Feb 2021 10:09:27 +0100 Subject: [PATCH] auth ldap docs: s/authmethod/bindmethod/ --- .github/actions/spell-check/expect.txt | 1 - docs/backends/ldap.rst | 10 +++++----- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/.github/actions/spell-check/expect.txt b/.github/actions/spell-check/expect.txt index dca38257e2..ff08f26f80 100644 --- a/.github/actions/spell-check/expect.txt +++ b/.github/actions/spell-check/expect.txt @@ -98,7 +98,6 @@ aton attr atype AUTHIP -authmethod Authoritativedoc auths authzone diff --git a/docs/backends/ldap.rst b/docs/backends/ldap.rst index e2242cc8e0..0999c3e9ff 100644 --- a/docs/backends/ldap.rst +++ b/docs/backends/ldap.rst @@ -108,9 +108,9 @@ complete. (default: "5") : The number of attempts to make to re-establish a lost connection to the LDAP server. -.. _setting-ldap-authmethod: +.. _setting-ldap-bindmethod: -``ldap-authmethod`` +``ldap-bindmethod`` ^^^^^^^^^^^^^^^^^^^ (default: "simple") : How to authenticate to the LDAP server. Actually @@ -124,7 +124,7 @@ password, or "gssapi", which requires a Kerberos keytab. (default "") : Path to the object to authenticate against. Should only be used, if the LDAP server doesn't support anonymous binds and with the -"simple" authmethod. +"simple" bindmethod. .. _setting-ldap-secret: @@ -132,7 +132,7 @@ be used, if the LDAP server doesn't support anonymous binds and with the ^^^^^^^^^^^^^^^ (default "") : Password for authentication against the object specified -by ldap-binddn. Only used when "authmethod" is "simple". +by ldap-binddn. Only used when "bindmethod" is "simple". .. _setting-ldap-krb5-keytab: @@ -140,7 +140,7 @@ by ldap-binddn. Only used when "authmethod" is "simple". ^^^^^^^^^^^^^^^^^^^^ (default: "") : Full path to the keytab file to use to authenticate. -This is only used when "authmethod" is set to "gssapi". The keytab must, +This is only used when "bindmethod" is set to "gssapi". The keytab must, ideally, contain only one principal (or to put it otherwise, only the first principal found in the keytab will be used). -- 2.47.2