Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ansible-doc output format #2

Merged
merged 1 commit into from
Oct 28, 2024
Merged

Update ansible-doc output format #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 16 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,57 +9,57 @@ Role Variables
--------------

```
ENTRY POINT: main - Install and configure caddy webserver
ENTRY POINT: *main* - Install and configure caddy webserver

Installs the caddy webserver and non-standard caddy plugins.
Allows for configuration of caddy through adding one or more
Caddyfiles.
Installs the caddy webserver along with any non-standard
caddy plugins required. Allows for caddy to be configured by
adding one or more Caddyfiles.

Options (red indicates it is required):
Options (= indicates it is required):

caddy_apt_key_fingerprint Fingerprint for caddy apt repo GPG key
- caddy_apt_key_fingerprint Fingerprint for caddy apt repo GPG key
default: 65760C51EDEA2017CEA2CA15155B6D79CA56EA34
type: str

caddy_apt_key_url URL for caddy apt repo GPG key
- caddy_apt_key_url URL for caddy apt repo GPG key
default: https://dl.cloudsmith.io/public/caddy/stable/gpg.key
type: str

caddy_apt_packages List of packages to install
- caddy_apt_packages List of packages to install
default: [caddy]
elements: str
type: list

caddy_apt_repo Entry for caddy apt repo in sources.list file
- caddy_apt_repo Entry for caddy apt repo in sources.list file
default: https://dl.cloudsmith.io/public/caddy/stable/deb/debian any-version main
type: str

caddy_dpkg_hook_script Path to where dpkg hook for caddy should be installed
- caddy_dpkg_hook_script Path to where dpkg hook for caddy should be installed
default: /usr/local/bin/caddy-upgrade
type: str

caddy_file Contents of the /etc/caddy/Caddyfile configuration file, or empty
- caddy_file Contents of the /etc/caddy/Caddyfile configuration file, or empty
string to leave file as is
default: ''
type: str

caddy_files List of additional Caddyfiles to create
- caddy_files List of additional Caddyfiles to create
default: []
elements: dict
type: list
options:

config Contents of the Caddyfile
= config Contents of the Caddyfile
type: str

dir Directory for the Caddyfile
- dir Directory for the Caddyfile
default: null
type: str

name Name of the Caddyfile
= name Name of the Caddyfile
type: str

caddy_packages List of non-standard caddy packages to install
- caddy_packages List of non-standard caddy packages to install
default: []
elements: str
type: list
Expand Down