[frontend] comment configuration file

Author: ar2rsawseen

frontend/express/config.sample.js

@@ -1,4 +1,24 @@
+/**
+* Module for user provided dashboard configurations
+* @module frontend/express/config
+*/
+
+/** @lends module:frontend/express/config */
 var countlyConfig = {
+    /**
+    * MongoDB connection definition and options
+    * @type {object} 
+    * @property {string} [host=localhost] - host where to connect to mongodb, default localhost
+    * @property {array=} replSetServers - array with multiple hosts, if you are connecting to replica set, provide this instead of host
+    * @property {string=} replicaName - replica name, must provide for replica set connection to work
+    * @property {string} [db=countly] - countly database name, default countly
+    * @property {number} [port=27017] - port to use for mongodb connection, default 27017
+    * @property {number} [max_pool_size=500] - how large pool size connection per process to create, default 500 per process, not recommended to be more than 1000 per server
+    * @property {string=} username - username for authenticating user, if mongodb supports authentication
+    * @property {string=} password - password for authenticating user, if mongodb supports authentication
+    * @property {object=} dbOptions - provide raw driver database options
+    * @property {object=} serverOptions - provide raw driver server options, used for all, single, mongos and replica set servers
+    */
     mongodb: {
         host: "localhost",
         db: "countly",
@@ -42,12 +62,34 @@ var countlyConfig = {
 	//mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]]
 	mongodb: "mongodb://localhost:27017/countly",
     */
+    /**
+    * Default dashboard configuration
+    * @type {object} 
+    * @property {number} [port=6001] - api port number to use, default 6001
+    * @property {string} [host=localhost] - host to which to bind connection
+    * @property {boolean} use_intercom - true, to use intercom in dashboard for communication with Countly
+    * @property {string} track - allow Countly to collect stats about amount of apps and datapoints as well as feature usage. 
+    * Possible values are: 
+    *    "all" - track all, 
+    *    "GA" - track only Global admins, 
+    *    "noneGA" - track only users who are not Global admins, 
+    *    "none" - not to track anything or anyone
+    */
     web: {
         port: 6001,
         host: "localhost",
-        use_intercom: true
+        use_intercom: true,
+        track:"all"
     },
+    /**
+    * Legacy value, not supported
+    * @type {string} 
+    */
 	path: "",
+    /**
+    * Legacy value, not supported
+    * @type {string} 
+    */
 	cdn: ""
 };