Skip to content

sous-chefs/htpasswd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

htpasswd Cookbook

Cookbook Version Build Status OpenCollective OpenCollective License

Manage users in htpasswd files.

Maintainers

This cookbook is maintained by the Sous Chefs. The Sous Chefs are a community of Chef cookbook maintainers working together to maintain important cookbooks. If you’d like to know more please visit sous-chefs.org or come chat with us on the Chef Community Slack in #sous-chefs.

Requirements

Platforms

  • CentOS 7+
  • Debian 9+
  • Ubuntu 16.04+ LTS

Chef Infra

This cookbook requires Chef Infra >= 15.3.

Resource/Provider

htpasswd

Actions

  • :add: Add a login in a htpasswd file. Update and modify it if there is already one and create file if not found (default)
  • :overwrite: Overwrite an htpasswd file (delete file and add user) NOTE: This action is not idempotent.
  • :delete: Delete a login in a htpasswd file.

Parameters

  • :file: Path of the htpasswd to manage
  • :user: User to create
  • :password: Password for the user
  • :type: Password algorithm to use. Valid options are: "md5", "bcrypt", "sha1", "plaintext", or "crypt". Default is "md5"
  • :mode: File mode for the file. Default is 0640.

Example

# add user "foo" with password "bar" to "/etc/nginx/htpassword" with the default md5 type.
htpasswd "/etc/nginx/htpassword" do
  user "foo"
  password "bar"
end

# add user "foo" with password "bar" using sha1 as the type.
htpasswd "/etc/nginx/htpassword" do
  user "foo"
  password "bar"
  type "sha1"
end

# add user "foo" with encrypted password using plaintext as the type.
htpasswd "/etc/nginx/htpassword" do
  user "foo"
  password "$apr1$H5Z8CUB.$L3wyxUF1ZDd.oZFlTkJ4X."
  type "plaintext"
end

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers!

https://opencollective.com/sous-chefs#backers

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website.

https://opencollective.com/sous-chefs/sponsor/0/website https://opencollective.com/sous-chefs/sponsor/1/website https://opencollective.com/sous-chefs/sponsor/2/website https://opencollective.com/sous-chefs/sponsor/3/website https://opencollective.com/sous-chefs/sponsor/4/website https://opencollective.com/sous-chefs/sponsor/5/website https://opencollective.com/sous-chefs/sponsor/6/website https://opencollective.com/sous-chefs/sponsor/7/website https://opencollective.com/sous-chefs/sponsor/8/website https://opencollective.com/sous-chefs/sponsor/9/website