ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-07-20 11:50:22 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

htpasswd: doc adjustment (#10313)

Browse source
This commit is contained in:
Alexei Znamensky 2025-07-01 00:37:01 +12:00 • committed by GitHub
commit cc2e067907
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 7 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

11
plugins/modules/htpasswd.py
View file

@ -46,10 +46,13 @@ options:
description: description:
- Hashing scheme to be used. As well as the four choices listed here, you can also use any other hash supported by passlib, - 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. 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 Only some schemes in addition to the four choices below are compatible with Apache or Nginx, and supported schemes
depend on passlib version and its dependencies. 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). - 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).' - '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] aliases: [crypt_scheme]
state: state:
type: str type: str
@ -63,8 +66,8 @@ options:
type: bool type: bool
default: true default: true
description: 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) - Used with O(state=present). If V(true), the file is created if it does not exist. Conversely, if set to V(false) and
and the file does not exist it will fail. the file does not exist, it fails.
notes: notes:
- This module depends on the C(passlib) Python library, which needs to be installed on all target systems. - 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).' - 'On Debian < 11, Ubuntu <= 20.04, or Fedora: install C(python-passlib).'