• Docs »
  • htpasswd - manage user files for basic authentication

htpasswd - manage user files for basic authentication

New in version 1.3.


  • Add and remove username/password entries in a password file using htpasswd.
  • This is used by web servers such as Apache and Nginx for basic authentication.


The below requirements are needed on the host that executes this module.

  • passlib>=1.6


Parameter Choices/Defaults Comments
(added in 2.3)
Attributes the file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr.

aliases: attr
  • no
  • yes ←
Used with state=present. If specified, the file will be created if it does not already exist. If set to "no", will fail if the file does not exist
  • apr_md5_crypt ←
  • des_crypt
  • ldap_sha1
  • plaintext
Encryption scheme to be used. As well as the four choices listed here, you can also use any other hash supported by passlib, such as md5_crypt and sha256_crypt, which are linux passwd hashes. If you do so the password file will not be compatible with Apache or Nginx
Name of the group that should own the file/directory, as would be fed to chown.
Mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either specify the leading zero so that Ansible's YAML parser knows it is an octal number (like 0644 or 01777) or quote it (like '644' or '0644' so Ansible receives a string and can do its own conversion from string into number. Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r).
User name to add or remove

aliases: username
Name of the user that should own the file/directory, as would be fed to chown.
Password associated with user.
Must be specified if user does not exist yet.
Path to the file that contains the usernames and passwords

aliases: dest, destfile
selevel Default:
Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range. _default feature works as for seuser.
Role part of SELinux file context, _default feature works as for seuser.
Type part of SELinux file context, _default feature works as for seuser.
User part of SELinux file context. Will default to system policy, if applicable. If set to _default, it will use the user portion of the policy if available.
  • present ←
  • absent
Whether the user entry should be present or not

(added in 2.2)
  • no ←
  • yes
Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.
This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.



  • This module depends on the passlib Python library, which needs to be installed on all target systems.
  • On Debian, Ubuntu, or Fedora: install python-passlib.
  • On RHEL or CentOS: Enable EPEL, then install python-passlib.


# Add a user to a password file and ensure permissions are set
- htpasswd:
    path: /etc/nginx/passwdfile
    name: janedoe
    password: '9s36?;fyNp'
    owner: root
    group: www-data
    mode: 0640

# Remove a user from a password file
- htpasswd:
    path: /etc/apache2/passwdfile
    name: foobar
    state: absent

# Add a user to a password file suitable for use by libpam-pwdfile
- htpasswd:
    path: /etc/mail/passwords
    name: alex
    password: oedu2eGh
    crypt_scheme: md5_crypt


This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.


This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.

For a list of other modules that are also maintained by the Ansible Community, see here.


  • Ansible Core Team


If you notice any issues in this documentation you can edit this document to improve it.