[PR #10313/cc2e0679 backport][stable-10] htpasswd: doc adjustment (#10316)
Some checks are pending
EOL CI / EOL Sanity (Ⓐ2.15) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.15+py2.7) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.15+py3.10) (push) Waiting to run
EOL CI / EOL Units (Ⓐ2.15+py3.5) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+alpine3+py:azp/posix/3/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/1/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/2/) (push) Waiting to run
EOL CI / EOL I (Ⓐ2.15+fedora37+py:azp/posix/3/) (push) Waiting to run
nox / Run extra sanity tests (push) Waiting to run

htpasswd: doc adjustment (#10313)

(cherry picked from commit cc2e067907)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
This commit is contained in:
patchback[bot] 2025-06-30 20:33:01 +02:00 committed by GitHub
parent 2f623b7398
commit 84a6f610f7
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -46,10 +46,13 @@ options:
description:
- Hashing scheme to be used. As well as the four choices listed here, you can also use any other hash supported by passlib,
such as V(portable_apache22) and V(host_apache24); or V(md5_crypt) and V(sha256_crypt), which are Linux passwd hashes.
Only some schemes in addition to the four choices below will be compatible with Apache or Nginx, and supported schemes
depend on passlib version and its dependencies.
Only some schemes in addition to the four choices below are compatible with Apache or Nginx, and supported schemes
depend on C(passlib) version and its dependencies.
- See U(https://passlib.readthedocs.io/en/stable/lib/passlib.apache.html#passlib.apache.HtpasswdFile) parameter C(default_scheme).
- 'Some of the available choices might be: V(apr_md5_crypt), V(des_crypt), V(ldap_sha1), V(plaintext).'
- 'B(WARNING): The module has no mechanism to determine the O(hash_scheme) of an existing entry, therefore, it does
not detect whether the O(hash_scheme) has changed. If you want to change the scheme, you must remove the existing
entry and then create a new one using the new scheme.'
aliases: [crypt_scheme]
state:
type: str
@ -63,8 +66,8 @@ options:
type: bool
default: true
description:
- Used with O(state=present). If V(true), the file will be created if it does not exist. Conversely, if set to V(false)
and the file does not exist it will fail.
- Used with O(state=present). If V(true), the file is created if it does not exist. Conversely, if set to V(false) and
the file does not exist, it fails.
notes:
- This module depends on the C(passlib) Python library, which needs to be installed on all target systems.
- 'On Debian < 11, Ubuntu <= 20.04, or Fedora: install C(python-passlib).'