Module for user provided dashboard configurations
- Description:
Module for user provided dashboard configurations
- Source:
Members
(static) cdn :string
- Description:
Legacy value, not supported
- Source:
Legacy value, not supported
Type:
- string
(static) cookie :object
- Description:
Cookie configuration
- Source:
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
path |
string |
<optional> |
/
|
path where cookie is accessible |
httpOnly |
boolean |
<optional> |
true
|
should cookies be http only |
secure |
boolean |
<optional> |
false
|
true, to use secure cookies, enable only if you have https enabled |
maxAge |
number |
<optional> |
1day
|
miliseconds for how long cookie should last |
maxAgeLogin |
number |
<optional> |
1year
|
miliseconds for how long cookie should last for authenticated users |
domain |
string | domain name on which cookie is valide, by default current domain |
||
expires |
Date | alternative to maxAge, specifies the Date object to be the value for the Expires Set-Cookie attribute |
||
sameSite |
boolean | string | specifies the boolean or string to be the value for the SameSite Set-Cookie attribute. |
Cookie configuration
Type:
- object
(static) mongodb :object
- Description:
MongoDB connection definition and options
- Source:
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
host |
string |
<optional> |
localhost
|
host where to connect to mongodb, default localhost |
replSetServers |
array |
<optional> |
array with multiple hosts, if you are connecting to replica set, provide this instead of host |
|
replicaName |
string |
<optional> |
replica name, must provide for replica set connection to work |
|
db |
string |
<optional> |
countly
|
countly database name, default countly |
port |
number |
<optional> |
27017
|
port to use for mongodb connection, default 27017 |
max_pool_size |
number |
<optional> |
500
|
how large pool size connection per process to create, default 500 per process, not recommended to be more than 1000 per server |
username |
string |
<optional> |
username for authenticating user, if mongodb supports authentication |
|
password |
string |
<optional> |
password for authenticating user, if mongodb supports authentication |
|
dbOptions |
object |
<optional> |
provide raw driver database options |
|
serverOptions |
object |
<optional> |
provide raw driver server options, used for all, single, mongos and replica set servers |
MongoDB connection definition and options
Type:
- object
(static) passwordSecret
- Description:
Additional password secret for safer autentification. This secret will be added on changing and creating password. Changing value in configs will result in invalid passwords for existing users. Default value is "".
- Source:
Additional password secret for safer autentification. This secret will be added on changing and creating password. Changing value in configs will result in invalid passwords for existing users. Default value is "".
(static) path :string
- Description:
Legacy value, not supported
- Source:
Legacy value, not supported
Type:
- string
(static) web :object
- Description:
Default dashboard configuration
- Source:
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
port |
number |
<optional> |
6001
|
dashboard port number to use, default 6001 |
host |
string |
<optional> |
localhost
|
host to which to bind connection |
use_intercom |
boolean | true, to use internal communication in dashboard for communication with Countly |
||
secure_cookies |
boolean | true, to use secure cookies, enable only if you have https enabled |
||
session_secret |
string | secret used to sign the session ID cookie. |
||
session_name |
string |
<optional> |
connect.sid
|
name of the session cookie |
theme= |
string |
<optional> |
the name/folder of the theme |
|
track |
string | allow Countly to collect stats about amount of apps and datapoints as well as feature usage. |
Default dashboard configuration
Type:
- object