Ansible weareinteractive.htpasswd role

weareinteractive.htpasswd is an Ansible role which:

installs htpasswd

manages htpasswd files

Note:

Since Ansible Galaxy supports organization now, this role has moved from franklinkim.htpasswd to weareinteractive.htpasswd!

Installation

Using ansible-galaxy:

$ ansible-galaxy install weareinteractive.htpasswd

Using requirements.yml:

- src: weareinteractive.htpasswd

Using git:

$ git clone https://github.com/weareinteractive/ansible-htpasswd.git weareinteractive.htpasswd

Dependencies

Ansible >= 2.0

Variables

Here is a list of all the default variables for this role, which are also available in defaults/main.yml.

---
#
# htpasswd:
#   - name: myapp
#     users:
#       - { name: user1, password: secret1 }
#   - name: otherapp
#     path: /foo/bar
#     users:
#       - { name: user2, password: secret2, crypt: ldap_sha1 }
#       - { name: user3, password: secret3, state: absent }

# list of entries
htpasswd: []
# path to auth files
htpasswd_path: /etc/htpasswd
# default crypt [apr_md5_crypt | des_crypt | ldap_sha1 | plaintext]
htpasswd_crypt: apr_md5_crypt
# auth files owner
htpasswd_owner: root
# auth files group
htpasswd_group: root
# auth files mode
htpasswd_mode: "0644"
# no log information by default to prevent showing passwords
htpasswd_no_log: yes
# list created and removed users after the action is done. Useful because no_log is enabled so
# everything is masked and sometimes you want to know what changed
htpasswd_list_users: false

Usage

This is an example playbook:

---

- hosts: all
  become: yes
  roles:
    - weareinteractive.htpasswd
  vars:
    htpasswd:
      - name: myapp
        users:
          - { name: user1, password: secret1 }
      - name: otherapp
        path: /usr/local/etc
        users:
          - { name: user2, password: secret2 }
          - { name: user3, password: secret3 }
        mode: "0600"
        group: staff
    htpasswd_no_log: no

Testing

$ git clone https://github.com/weareinteractive/ansible-htpasswd.git
$ cd ansible-htpasswd
$ make test

Contributing

In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests and examples for any new or changed functionality.

Fork it
Create your feature branch (git checkout -b my-new-feature)
Commit your changes (git commit -am 'Add some feature')
Push to the branch (git push origin my-new-feature)
Create new Pull Request

Note: To update the README.md file please install and run ansible-role:

$ gem install ansible-role
$ ansible-role docgen

weareinteractive/ansible-htpasswd