diff --git a/USER_GUIDE.md b/USER_GUIDE.md index 7a83038..f9d55ae 100644 --- a/USER_GUIDE.md +++ b/USER_GUIDE.md @@ -41,6 +41,7 @@ Option | Default Value | Valid Options | Environment Variable | Description --subject | This is an email containing your dashboard report | - | OPENSEARCH_SUBJECT | subject for the email --note | Hi,\nHere is the latest report! | string or path to text file | OPENSEARCH_EMAIL_NOTE | The email body --selfsignedcerts | false | true, false | - | enable or disable self-signed certicates for smtp transport +--timeout | 300000ms | - | OPENSEARCH_TIMEOUT | timeout for generating report in ms | - | - | - | CHROMIUM_PATH | path to chromium directory You can also find this information using help command. diff --git a/src/arguments.js b/src/arguments.js index 0099183..516588f 100644 --- a/src/arguments.js +++ b/src/arguments.js @@ -68,7 +68,7 @@ async function getCommandArguments() { .addOption(new Option('--selfsignedcerts ', 'enable or disable self-signed certicates for smtp transport') .default(DEFAULT_SELF_SIGNED_CERTIFICATES) .choices(['true', 'false'])) - .addOption(new Option('--timeout ', 'timeout for generating report') + .addOption(new Option('--timeout ', 'timeout for generating report in ms') .default(DEFAULT_TIMEOUT) .env(ENV_VAR.TIMEOUT)); diff --git a/test/help.test.js b/test/help.test.js index c9acc8a..ad01ada 100644 --- a/test/help.test.js +++ b/test/help.test.js @@ -34,7 +34,7 @@ Options: --subject email subject (default: "This is an email containing your opensearch dashboard report", env: OPENSEARCH_EMAIL_SUBJECT) --note email body (string or path to text file) (default: "Hi,\\nHere is the latest report!", env: OPENSEARCH_EMAIL_NOTE) --selfsignedcerts enable or disable self-signed certicates for smtp transport (choices: "true", "false", default: false) - --timeout timeout for generating report (default: 300000, env: OPENSEARCH_TIMEOUT) + --timeout timeout for generating report in ms (default: 300000, env: OPENSEARCH_TIMEOUT) -h, --help display help for command Note: The tenant in the url has the higher priority than tenant value provided as command option.