Add a vhost role
This commit is contained in:
44
docs/vhost.md
Normal file
44
docs/vhost.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# Required variables
|
||||
These variables are required for this role to function. Example values provided
|
||||
|
||||
```
|
||||
vhost_id: myservice # A unique identifier for this vhost. Not visible to end users.
|
||||
vhost_type: reverse_proxy # Supported values: reverse_proxy, redirect
|
||||
vhost_domains:
|
||||
- www.domain.tld
|
||||
- domain.tld
|
||||
```
|
||||
|
||||
# Optional variables
|
||||
These variables have the following default values.
|
||||
|
||||
```
|
||||
web_server: caddy # Supported values: caddy, none
|
||||
```
|
||||
|
||||
# Variables specific to vhost type
|
||||
## reverse\_proxy
|
||||
|
||||
Required:
|
||||
```
|
||||
proxy_target_port: 8080
|
||||
```
|
||||
|
||||
Optional:
|
||||
```
|
||||
proxy_target_host: localhost
|
||||
proxy_target_protocol: http
|
||||
```
|
||||
|
||||
## redirect
|
||||
|
||||
Required:
|
||||
```
|
||||
redirect_target: https://www.domain.tld/location
|
||||
```
|
||||
|
||||
Optional:
|
||||
```
|
||||
redirect_type: temporary # Supported values: temporary, permanent
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user