diff --git a/guide/reference/settings.md b/guide/reference/settings.md index 701e9cc8..30bb1682 100644 --- a/guide/reference/settings.md +++ b/guide/reference/settings.md @@ -86,6 +86,17 @@ Below are the default settings that will be passed to the Nightwatch instance du false Disable the global apis like "browser", "element()", "expect()"; this might be needed if using Nightwatch with third-party libraries. + + usage_analytics
since v3.0 + object + + By default Nightwatch sends anonymous usage data to Browserstack for product planing purposes. This setting can be used to disable that. + +Example: + usage_analytics: { + enabled: false + } + @@ -673,6 +684,42 @@ The `"selenium"` settings should also be used when configuring connections to cl +### Analytics Data Settings +If your project is created using `npm init nightwatch`, then Nightwatch will send anonymous usage data to Browserstack by default. +This behaviour can be modified using the `usage_analytics` property in `nightwatch.conf.js`. Following are the properties that can be configured. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Nametypedefaultdescription
enabledbooleantrueWhether or not send usage data.
log_pathstring./logs/analyticsBefore sending the data to analytics server, it is saved locally in this location
client_idstringsome generated valueUnique client id generated during npm init nightwatch or during the first run.
+ ### Selenium Example Configuration Here's an example configuration as part of the `nightwatch.conf.js` which uses a local Selenium Server with support for Firefox, Chrome, and Internet Explorer.