Forge Home

Modules

Resources

PuppetEcosystemPuppet CommunityUpdates

letsencrypt_client

Configure the letsencrypt cli tool and generate certificates using defined types
Project URLRSS FeedReport issues

8,882 downloads

7,103 latest version

3.7 quality score

We run a couple of automated
scans to help you access a
module's quality. Each module is
given a score based on how well
the author has formatted their
code and documentation and
modules are also checked for
malware using VirusTotal.

Please note, the information below
is for guidance only and neither of
these methods should be considered
an endorsement by Puppet.

Version information

  • 0.1.5 (latest)
  • 0.1.4
  • 0.1.3
  • 0.1.2
  • 0.1.1
  • 0.1.0
released Mar 3rd 2016

Start using this module

  • r10k or Code Manager
  • Bolt
  • Manual installation
  • Direct download

Add this module to your Puppetfile:

mod 'demophoon-letsencrypt_client', '0.1.5'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add demophoon-letsencrypt_client
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install demophoon-letsencrypt_client --version 0.1.5

Direct download is not typically how you would use a Puppet module to manage your infrastructure, but you may want to download the module in order to inspect the code.

Download

Documentation

demophoon/letsencrypt_client — version 0.1.5 Mar 3rd 2016

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
  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 britt@brittg.com