README.md

Puppet module for Caddy

Table of Contents

1. Description
2. Setup - The basics of getting started with Caddy
   • What Caddy affects
   • Setup requirements
   • Beginning with Caddy
3. Usage - Configuration options and additional functionality
4. Limitations - OS compatibility, etc.
5. Development - Guide for contributing to the module

Description

This module installs and configures Caddy - The HTTP/2 web server with automatic HTTPS.

Important: This module only supports the installation of Caddy 2.x. If you want to install Caddy 1.x, you should use version v2.0.0 of this module.

Setup

What Caddy affects

• Caddy binary
• Caddy configuration file
• Caddy virtual hosts
• Caddy service

Setup Requirements

This module has the following dependencies:

• camptocamp/systemd
• puppet/archive
• puppetlabs/stdlib
• stm/file_capability

Beginning with Caddy

Install Caddy without any configuration:

include caddy

Usage

Install customised version of Caddy

class { 'caddy':
  caddy_features => 'http.git,http.filter,http.ipfilter',
}

Install specific version of Caddy

class { 'caddy':
  version        => '2.0.0',
  install_method => 'github',
}

Install Caddy and configure virtual host, based on source:

caddy::vhost { 'example1':
  source => 'puppet:///modules/caddy/etc/caddy/config/example1.conf',
}

Install Caddy and configure virtual host, based on content:

caddy::vhost { 'example2':
  content => 'localhost:2015',
}

Reference

The reference documentation of this module is generated using puppetlabs/puppetlabs-strings.

Limitations

This module has been tested on:

• RedHat 7/8
• CentOS 7/8
• Debian 8/9/10
• Ubuntu 16.04/18.04

Development

This module has grown over time based on a range of contributions from people using it. If you follow these contributing guidelines your patch will likely make it into a release a little more quickly.

Author

This module is maintained by Vox Pupuli. It was originally written and maintained by Lukasz Rohde.