From d55f887d9c5de0f618b7178dc4e114116c5b949e Mon Sep 17 00:00:00 2001 From: "Demi [Alvaro Martinez de Miguel]" Date: Wed, 16 Oct 2019 14:26:36 +0200 Subject: [PATCH] update documentation for cors option --- README.md | 4 ++++ cli/help/help.go | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/README.md b/README.md index 1fad068..9ae1048 100644 --- a/README.md +++ b/README.md @@ -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: diff --git a/cli/help/help.go b/cli/help/help.go index 6f8a3fa..d8faff1 100644 --- a/cli/help/help.go +++ b/cli/help/help.go @@ -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: