Files
ansible-general/roles/vhost/meta/argument_specs.yml
2022-11-18 05:38:17 +02:00

53 lines
1.4 KiB
YAML

---
argument_specs:
main:
short_description: Sets up a vhost
options:
vhost_id:
description: A unique identifier for this vhost. Not visible to end users.
type: str
required: true
vhost_type:
type: str
required: true
choices:
- reverse_proxy
- redirect
vhost_domains:
type: list
required: true
elements: str
web_server:
description: Defines which server software to use for vhost. This role does nothing if set to none
type: str
required: false
default: caddy
choices:
- caddy
- none
proxy_target_port:
description: Required and only applicable if vhost_type is reverse_proxy
type: int
proxy_target_host:
description: Only applicable if vhost_type is reverse_proxy
type: str
default: localhost
proxy_target_protocol:
description: Only applicable if vhost_type is reverse_proxy
type: str
default: http
redirect_target:
description: "Required and only applicable if vhost_type is redirect. Example: https://www.domain.tld/location"
type: str
redirect type:
description: Only applicable if vhost_type is reverse_proxy
type: str
default: temporary
choices:
- temporary
- permanent