letsencrypt_client
Version information
Start using this module
Add this module to your Puppetfile:
mod 'demophoon-letsencrypt_client', '0.1.5'Learn more about managing modules with a PuppetfileDocumentation
letsencrypt_client
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with letsencrypt_client
- Usage - Configuration options and additional functionality
- Reference - An under-the-hood peek at what the module is doing and how
- Limitations - OS compatibility, etc.
- 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
Dependencies
- stankevich-python (>= 1.10.0)
Copyright (c) 2015 Britt Gresham. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.