demophoon / letsencrypt-client

Puppet module for configuring the letsencrypt client and using it to request certificates

letsencrypt_client

Table of Contents

1. Overview
2. Module Description - What the module does and why it is useful
3. Setup - The basics of getting started with letsencrypt_client
   • What letsencrypt_client affects
   • Setup requirements
4. Usage - Configuration options and additional functionality
5. Reference - An under-the-hood peek at what the module is doing and how
6. Limitations - OS compatibility, etc.
7. Development - Guide for contributing to the module

Overview

This module is for managing letsencrypt certificates with puppet. It does not automatically install the certificates to the web server as that is out of scope for this project.

Module Description

Currently the module handles installing the letsencrypt cli tool for the module to then use to request certificates using the defined resource type. Certificates will automatically be renewed when the cert has less than 30 days left until it expires.

Setup

What letsencrypt_client affects

• Installs python, virtualenv, pip, and letsencrypt

Setup Requirements

• Requires openssl to be installed and in /usr/bin

Usage

Simply use the letsencrypt_client::cert defined resource type to request a certificate from letsencrypt's CA.

Reference

letsencrypt_client::cert { "www.example.com",
  webroot => "/var/www",
  domain_name => "$title",
}

letsencrypt_client::cert { "www.example.com",
  domains => [
    {
      webroot     => '/path/to/webroot',
      domain_name => 'example.com',
    },
    {
      webroot     => '/path/to/webroot',
      domain_name => 'www.example.com',
    },
  ],
}

Limitations

This has been tested on Ubuntu 14.04.3 LTS

Development

The source is at https://github.com/demophoon/letsencrypt-client. Feel free to submit issues and or enhancement requests there.

Release Notes/Contributors/Etc

Britt Gresham [e-mail]