kmpm.caddy

This is a role to install and set up the Caddy server.

If you provide any custom modules through the xcaddy_with variable, Caddy will be built from source using xcaddy on the remote machine.

Requirements

You need to install the following package:

pip install github3.py

Role Variables

• caddy_version: latest: This allows you to choose a specific version of Caddy or the latest version.

  caddy_version: 2.4.5
  

• caddy_user: caddy: This sets the user name that will run Caddy.

• caddy_group: "{{ caddy_user }}": This sets the group name that will run Caddy.

• caddy_caddyfile_template: mycaddyfile.j2: This lets you use a different template for the Caddyfile.

• xcaddy_with: []: This is a list of modules to include. It will cause Caddy to be custom compiled using Golang and xcaddy.

  xcaddy_with:
    - "github.com/caddy-dns/loopia"
  

Used during xcaddy compilation

• The role will install Git if it’s not already installed and if caddy_version is not set to "latest".

• xcaddy_version: latest: This is the xcaddy release version to use when compiling.

• golang_version: 0.17.9: This sets the version of Golang to install if it is not found in /usr/local/go/bin.

Dependencies

Collections

• community.general

Example Playbook

Here’s an example of how to use this role (with parameters):

- hosts: servers
  roles:
     - { role: kmpm.caddy, caddy_version: 'latest' }

License

MIT License

Inspiration

• Jeff Geerling's Blog on Testing Ansible Roles
• Red Hat’s Guide on Testing Roles
• Installing Python on Raspberry Pi