api/config

Module for user provided API configurations

Description:

  • Module for user provided API configurations

Source:

Members

(static) api :object

Description:

  • Default API configuration

Source:
Properties:
Name Type Attributes Default Description
port number <optional>
 3001

api port number to use, default 3001
host string <optional>
 localhost

host to which to bind connection
max_sockets number <optional>
 1024

maximal amount of sockets to open simultaneously
workers number

amount of paralel countly processes to run, defaults to cpu/core amount
timeout number <optional>
 120000

nodejs server request timeout, need to also increase nginx timeout too for longer requests
maxUploadFileSize number

limit the size of uploaded file

Default API configuration

Type:
  • object

(static) encryption :object

Description:
Source:
Properties:
Name Type Description
key string

key used for encryption and decryption
iv string | Buffer

initialization vector to make encryption more secure
algorithm string

name of the algorithm to use for encryption. The algorithm is dependent on OpenSSL, examples are 'aes192', etc. On recent OpenSSL releases, openssl list-cipher-algorithms will display the available cipher algorithms. Default value is aes-256-cbc
input_encoding string

how encryption input is encoded. Used as output for decrypting. Default utf-8.
output_encoding string

how encryption output is encoded. Used as input for decrypting. Default hex.
reports_key string

key used for encryption of reports links

Default settings to be used for module:api/utils/utils.encrypt and module:api/utils/utils.decrypt functions and for commandline

Type:
  • object

(static) fileStorage :string

Description:

  • Specifies where to store files. Value "fs" means file system or basically storing files on hard drive. Another currently supported option is "gridfs" storing files in MongoDB database using GridFS. By default fallback to "fs";

Source:

Specifies where to store files. Value "fs" means file system or basically storing files on hard drive. Another currently supported option is "gridfs" storing files in MongoDB database using GridFS. By default fallback to "fs";

Type:
  • string

(static) ignoreProxies :array

Description:

  • Default proxy settings, if provided then countly uses ip address from the right side of x-forwarded-for header ignoring list of provided proxy ip addresses

Source:

Default proxy settings, if provided then countly uses ip address from the right side of x-forwarded-for header ignoring list of provided proxy ip addresses

Type:
  • array

(static) logging :object

Description:

  • Default logging settings

Source:
Properties:
Name Type Attributes Default Description
default string <optional>
 warn

default level of logging for logger
info array <optional>

modules to log for information level for logger

Default logging settings

Type:
  • object

(static) mail :Object

Description:

  • Simple SMTP mail sender configuration. Can only be used when you don't have custom mailer extend ({@code countly/extend/mail.js}). If omited, sendmail will be used. Sendmail is not installed in Docker images.

Source:

Simple SMTP mail sender configuration. Can only be used when you don't have custom mailer extend ({@code countly/extend/mail.js}). If omited, sendmail will be used. Sendmail is not installed in Docker images.

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) path :string

Description:

  • Path to use for countly directory, empty path if installed at root of website

Source:

Path to use for countly directory, empty path if installed at root of website

Type:
  • string

(static) preventJobs

Description:

  • Specifies if jobs are run on this countly instance Usable only in case when there are multiple countly instances connected to single database. Has to be set to true for at least one instance.

Source:

Specifies if jobs are run on this countly instance Usable only in case when there are multiple countly instances connected to single database. Has to be set to true for at least one instance.

(static) reloadConfigAfter :integer

Description:

  • Specifies after how long time configurations are reloded from data base. Default value is 10000 (10 seconds)

Source:

Specifies after how long time configurations are reloded from data base. Default value is 10000 (10 seconds)

Type:
  • integer

(static) shared_connection

Description:

  • Share same database connection pool between databases

Source:

Share same database connection pool between databases