certbot(role): move arguments documentation into README
Do this to match how it's done in newer roles.
This commit is contained in:
parent
0331c77d55
commit
3820a97584
2 changed files with 9 additions and 9 deletions
|
|
@ -8,7 +8,15 @@ Also see the following documentation for a full How-to on how to get certificate
|
||||||
|
|
||||||
## Required Arguments
|
## Required Arguments
|
||||||
|
|
||||||
For the required arguments look at the [`argument_specs.yaml`](./meta/argument_specs.yaml).
|
- `certbot__acme_account_email_address`: The E-Mail address to use for the ACME account.
|
||||||
|
- `certbot__certificate_domains`: The domains for which to obtain a certificate.
|
||||||
|
|
||||||
|
## Optional Arguments
|
||||||
|
|
||||||
|
- `certbot__http_01_port`: The port number the bot listens on. Should be `80` if directly exposed to the internet.
|
||||||
|
Defaults to `31820` (for the public-reverse-proxy setup).
|
||||||
|
- `certbot__new_cert_commands`: A list of commands to execute after getting a new certificate. Will be added into a bash script.
|
||||||
|
Defaults to the empty list (`[ ]`).
|
||||||
|
|
||||||
## `hosts`
|
## `hosts`
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -2,25 +2,17 @@ argument_specs:
|
||||||
main:
|
main:
|
||||||
options:
|
options:
|
||||||
certbot__acme_account_email_address:
|
certbot__acme_account_email_address:
|
||||||
description: The E-Mail address to give to certbot for the ACME account.
|
|
||||||
type: str
|
type: str
|
||||||
required: true
|
required: true
|
||||||
certbot__certificate_domains:
|
certbot__certificate_domains:
|
||||||
description: The domains for which to obtain a certificate.
|
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
required: true
|
required: true
|
||||||
certbot__http_01_port:
|
certbot__http_01_port:
|
||||||
description: |
|
|
||||||
The port number the bot listens on. Must be 80 if directly exposed to the internet.
|
|
||||||
Default is 31820 for the public-reverse-proxy setup.
|
|
||||||
type: str
|
type: str
|
||||||
required: false
|
required: false
|
||||||
default: 31820
|
default: 31820
|
||||||
certbot__new_cert_commands:
|
certbot__new_cert_commands:
|
||||||
description: >-
|
|
||||||
A list of commands to execute after getting a new certificate.
|
|
||||||
Will be added into a bash script.
|
|
||||||
type: list
|
type: list
|
||||||
elements: str
|
elements: str
|
||||||
required: false
|
required: false
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue