update documentation for cors option

This commit is contained in:
Demi [Alvaro Martinez de Miguel] 2019-10-16 14:26:36 +02:00
parent f3f9442821
commit d55f887d9c
2 changed files with 9 additions and 0 deletions

View File

@ -14,6 +14,9 @@ Install from any of the following locations:
Default values are shown with the associated environment variable.
```bash
# Enables resource access from any domain.
CORS=false
# Enable debugging for troubleshooting. If set to 'true' this prints extra
# information during execution. IMPORTANT NOTE: The configuration summary is
# printed to stdout while logs generated during execution are printed to stderr.
@ -69,6 +72,7 @@ show-listing: true
tls-cert: ""
tls-key: ""
url-prefix: ""
cors: false
```
Example configuration with possible alternative values:

View File

@ -33,6 +33,10 @@ DEPENDENCIES
None... not even libc!
ENVIRONMENT VARIABLES
CORS
When set to 'true' it enables resource access from any domain. All responses
will include the headers 'Access-Control-Allow-Origin' and 'Access-Control-Allow-Headers'
with a wildcard value ('*').
DEBUG
When set to 'true' enables additional logging, including the
configuration used and an access log for each request. IMPORTANT NOTE:
@ -94,6 +98,7 @@ CONFIGURATION FILE
tls-cert: ""
tls-key: ""
url-prefix: ""
cors: false
----------------------------------------------------------------------------
Example config.yml with possible alternative values: