Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/voxpupuli/puppet-caddy
Puppet Caddy module
https://github.com/voxpupuli/puppet-caddy
centos-puppet-module debian-puppet-module hacktoberfest linux-puppet-module puppet redhat-puppet-module ubuntu-puppet-module
Last synced: about 1 hour ago
JSON representation
Puppet Caddy module
- Host: GitHub
- URL: https://github.com/voxpupuli/puppet-caddy
- Owner: voxpupuli
- License: mit
- Created: 2016-12-02T22:33:30.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-12T11:19:42.000Z (10 months ago)
- Last Synced: 2024-04-15T07:17:25.400Z (10 months ago)
- Topics: centos-puppet-module, debian-puppet-module, hacktoberfest, linux-puppet-module, puppet, redhat-puppet-module, ubuntu-puppet-module
- Language: Ruby
- Size: 248 KB
- Stars: 6
- Watchers: 40
- Forks: 12
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Puppet module for Caddy
[](https://travis-ci.org/voxpupuli/puppet-caddy)
[](https://coveralls.io/github/voxpupuli/puppet-caddy)
[](https://forge.puppetlabs.com/puppet/caddy)
[](https://forge.puppetlabs.com/puppet/caddy)
[](https://forge.puppetlabs.com/puppet/caddy)
[](https://forge.puppetlabs.com/puppet/caddy)
[](https://github.com/voxpupuli/puppet-caddy/blob/master/LICENSE)
## Table of Contents
1. [Description](#description)
1. [Setup - The basics of getting started with Caddy](#setup)
* [What Caddy affects](#what-caddy-affects)
* [Setup requirements](#setup-requirements)
* [Beginning with Caddy](#beginning-with-caddy)
1. [Usage - Configuration options and additional functionality](#usage)
1. [Limitations - OS compatibility, etc.](#limitations)
1. [Development - Guide for contributing to the module](#development)
## 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:
* [puppet/systemd](https://github.com/voxpupuli/puppet-systemd)
* [puppet/archive](https://github.com/voxpupuli/puppet-archive)
* [puppetlabs/stdlib](https://github.com/puppetlabs/puppetlabs-stdlib)
When `install_method` is set to 'repo', this module implicitly requires either
[puppetlabs-apt](https://github.com/puppetlabs/puppetlabs-apt) module for
Debian distro family, or [puppet-yum](https://github.com/voxpupuli/puppet-yum)
module for RedHat distro family.
### Beginning with Caddy
Install Caddy without any configuration:
```puppet
include caddy
```
## Usage
Install customized version of Caddy
```puppet
class { 'caddy':
caddy_features => 'http.git,http.filter,http.ipfilter',
}
```
Install specific version of Caddy
```puppet
class { 'caddy':
version => '2.0.0',
install_method => 'github',
}
```
Install Caddy and configure virtual host, based on source:
```puppet
caddy::vhost { 'example1':
source => 'puppet:///modules/caddy/etc/caddy/config/example1.conf',
}
```
Install Caddy and configure virtual host, based on content:
```puppet
caddy::vhost { 'example2':
content => 'localhost:2015',
}
```
Use apache-like configuration files layout:
```puppet
class { 'caddy':
config_dir => '/etc/caddy/conf-available',
config_enabled_dir => '/etc/caddy/conf-enabled',
vhost_dir => '/etc/caddy/sites-available',
vhost_enable_dir => '/etc/caddy/sites-enabled',
config_files => {
admin_port_2020 => {
content => "{\n admin localhost:2020\n}\n",
},
},
vhosts => {
port_3000 => {
content => "http://localhost:3000 {\n respond \\"port 3000\\"\n}\n",
},
port_3001 => {
ensure => 'disabled',
content => "http://localhost:3001 {\n respond \\"port 3001\\"\n}\n",
}
}
}
```
Same as above but configured in Hiera:
```yaml
caddy::config_dir: /etc/caddy/conf-available
caddy::config_enable_dir: /etc/caddy/conf-enabled
caddy::vhost_dir: /etc/caddy/sites-available
caddy::vhost_enable_dir: /etc/caddy/sites-enabled
caddy::config_files:
admin_port_2020:
content: |
{
admin localhost:2020
}
caddy::vhosts:
port_3000:
content: |
http://localhost:3000 {
respond "port 3000"
}
port_3001:
ensure: disabled
content: |
http://localhost:3001 {
respond "port 3001"
}
```
You may consider setting following parameters also. This allows
enabling/disabling config files and virtual hosts manually.
```yaml
caddy::purge_config_enable_dir: false
caddy::purge_vhost_enable_dir: false
```
## Reference
The [reference][1] documentation of this module is generated using [puppetlabs/puppetlabs-strings][2].
## Limitations
This module has been tested on:
* AlmaLinux 8/9
* CentOS 9
* Debian 11/12
* OracleLinux 8/9
* RedHat 8/9
* Rocky 8/9
* Ubuntu 20.04/22.04/24.04
For the official list of all tested distributions, please take a look at the [metadata.json](https://github.com/voxpupuli/puppet-caddy/blob/master/metadata.json#L24)
## Development
This module has grown over time based on a range of contributions from people
using it. If you follow these [contributing][3] guidelines your patch will
likely make it into a release a little more quickly.
## Author
This module is maintained by [Vox Pupuli][4]. It was originally written and
maintained by [Lukasz Rohde][5].
[1]: https://github.com/voxpupuli/puppet-caddy/blob/master/REFERENCE.md
[2]: https://github.com/puppetlabs/puppetlabs-strings
[3]: https://github.com/voxpupuli/puppet-caddy/blob/master/.github/CONTRIBUTING.md
[4]: https://voxpupuli.org
[5]: https://github.com/CommanderK5