Skip to content

maxhoesel-ansible/ansible-collection-caddy

Repository files navigation

maxhoesel.caddy - Ansible Collection for the Caddy webserver

Release Build Status License

An Ansible collection containing roles/modules to install, configure and interact with the caddy webserver.

Components


📘 Documentation

  • For role documentation, see their README.mds or the online docs here
  • For modules documentation, see the online docs here

Roles

Role Description
caddy_server Install the caddy server on your hosts.

Modules

Module Description
caddy_load Load a new config into Caddy
caddy_config_info Retrieve Caddys current configuration for a given path
caddy_config Create or update Caddys configuration for a given path

Installation

Dependencies

  • A recent release of Ansible. This collection officially supports the 2 most recent Ansible releases. Older versions might still work, but are not supported
  • Python 3.7 or newer on the target host
  • The modules require the requests python module on the remote host

Individual roles or modules may have additional dependencies, please check their respective documentation.

Install

Via ansible-galaxy (recommended):

ansible-galaxy collection install maxhoesel.caddy

Alternatively, you can download a collection archive from a previous release.

You can also clone this repository directly if you want a slightly more up-to-date (and potentially buggy) version.

ansible-galaxy collection install git+https://github.com/maxhoesel-ansible/ansible-collection-caddy

License & Author

Created & Maintained by Max Hösel (@maxhoesel) and Contributors

Licensed under the GPL 3.0 or later