ansible-nginx/doc/auth.md

Auth Basic management

IMPORTANT

If you use this feature with Debian Stretch, you MUST use ansible >= 2.3.2! See: https://github.com/HanXHX/ansible-nginx/issues/28.

Description

Auth basic is managed in a separate list. Each auth file can be shared between locations or sites.

Each htpasswd has few keys:

• name: (M) used to create file and as pointee
• description: (M) Used for the message box :)
• users: each users is composed with 3 keys: name (M), password (M) and state (O) present/absent (default: present)
• state: (O) present or absent. Default: present

nginx_htpasswd should be placed in a vault file.

Example

nginx_sites:
# htpasswd on all site
  - name: test.local
    htpasswd: 'hello'
    template: '_base'

# htpasswd only in /hello
  - name: test-location.local
    template: '_base'
    location:
      '/hello':
        - htpasswd: 'hello'

nginx_htpasswd:
  - name: 'hello'
    description: 'Please login!'
    users:
      - name: 'bob'
        password: 'my_pass'