Forge Home

Modules

Puppet

Resources

PuppetEcosystemPuppet CommunityUpdates

certbot

Install Certbot, the reference Let's Encrypt client from EFF
Project URLRSS FeedReport issues

12,095 downloads

7,541 latest version

5.0 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.

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

  1. Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
  2. Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

  • 0.2.1 (latest)
  • 0.2.0
  • 0.1.0
released Oct 9th 2018
This version is compatible with:
  • Puppet Enterprise 2023.8.x, 2023.7.x, 2023.6.x, 2023.5.x, 2023.4.x, 2023.3.x, 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2017.1.x, 2016.5.x, 2016.4.x
  • Puppet >= 4.5.0

Start using this module

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

Add this module to your Puppetfile:

mod 'praekeltfoundation-certbot', '0.2.1'
Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add praekeltfoundation-certbot
Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install praekeltfoundation-certbot --version 0.2.1

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

praekeltfoundation/certbot — version 0.2.1 Oct 9th 2018

puppet-certbot

Build Status Puppet Forge

Puppet module to manage the EFF's client for Let's Encrypt, Certbot

Why?

There are a few Puppet modules out there for Certbot/Let's Encrypt. Why have we written our own one? Other than a lack of maintenance on some of the existing modules, ours differs in that:

  • It installs Certbot from PyPI using pip in a virtualenv so that you can install the latest version
  • It runs Certbot as a non-root user with limited privileges by default
  • It automates all of the steps around enabling HTTPS for an Nginx server with Let's Encrypt certificates

Warning

We don't recommend you use this in production just yet for the following reasons:

  • There are no real tests yet
  • We've only used this on Debian 8 (Jessie)
  • We've only used this for webroot-based (http-01) challenges with Nginx and standalone challenges
  • We use some hacky Puppet features (virtual resources) to "auto-magically" set up SSL settings for Nginx servers
  • The code is likely to change substantially

Usage

Set up the basics:

class { 'certbot':
  email => 'letsencrypt@example.com',
}

Set up an Nginx server and certbot::nginx::virtual_server resource:

@nginx::resource::server { 'myserver':
  server_name => ['foo.example.com'],
  proxy       => 'http://localhost:5000/',
}

certbot::nginx::virtual_server { 'myserver': }

After one Puppet run the certificates should be issued. Run Puppet once more for the certificates to be used.

Note that by default this module will try to install the package 'python-virtualenv'. If this is not desired, pass manage_python => false.