Note: For Skedler Reports v3.12 and below, refer reporting.yml and report engine configuration
Skedler has two configuration files
- reporting.yml in $skedler_home/config folder
- reportingEngineOptions in $skedler_home/config folder
|1||port||Optional||Port in which Skedler runs.|
Default port is 3000.
|2||host||Optional||The host to bind the Skedler server. This bind address should be configured in /etc/hosts with hostname.|
If bind address is 127.0.0.1 then in /etc/hosts the following should be added
|3||basePath||Optional||Enables you to specify a path to mount Skedler at if you are running Skedler behind a proxy. This only affects the URL generated by Skedler, your proxy is expected to remove the basePath value before forwarding request to Skedler. This settings cannot end in a slash.|
|6||skedler_index||Optional||Skedler index which will be created in elasticsearch. It will create a new index if it doesn't exist.|
Default Skedler index is .skedler
|7||ui_files_location||Optional||When you update Skedler version you may require logo and images and custom CSS files which needs to be persisted. You can configure the location for location the files. Make sure the folder has read/write permission. The following folder in Skedler will be persisted.|
Enables you to specify a folder where Skedler stores the log output.
Default log output directory $skedler_home/log.
|SKEDLER REPORT SSL SETTINGS|
|Optional||Enables SSL and paths to the PEM-format SSL certificate and SSL key files, respectively. These settings enable SSL for outgoing requests from the Skedler server to the browser.|
|11||elasticsearch_url||Optional||Specify the Elasticsearch instance URL to store Skedler metadata and history data.|
|Optional||If Elasticsearch uses security or basic auth, add the security username and password here for Skedler.|
|Optional||Skedler history index which will be created in elasticsearch. It will create a new index if it doesn't already exist. Default Skedler_History is .skedler_reporthistory|
|14||elasticsearch_history_index_format||Optional||If skedler_history_index_format is set, the skedler history index will be created based on the format. For ex :skedler_reporthistory_2019-11-29 for 'YYYY-MM-DD'|
|Optional settings that provide the paths to the PEM-format SSL certificate and key files.|
These files validate that your Elasticsearch backend uses the same key files.
|16||elasticsearch_ssl_certificateAuthorities||Optional||Optional setting that enables you to specify a path to the PEM file for the certificate authority for your Elasticsearch instance.|
|17||elasticsearch_ssl_verificationMode||Optional||To disregard the validity of SSL certificates, change this setting's value to 'none'.|
|18||pingTimeout||Optional||Time in milliseconds to wait for Elasticsearch to respond to pings. This must be > 0.|
|19||requestTimeout||Optional||Time in milliseconds to wait for responses from Elasticsearch. This must be > 0.|
|18||database_type||Optional||Specify the database type either "mysql" or "sqlite"|
|Optional||For `mysql` database configuration, you can configure the database connection by specifying host, name, user and password.|
|Optional||For `sqlite` database configuration, you can specify the relative path.|
|21||max_conn||Optional||A maximum number of connections in the pool. The default value is set to 5|
|22||min_conn||Optional||A minimum number of connections in the pool. The default value is set to 0|
|23||conn_idle_time||Optional||The maximum time, in milliseconds, that a connection can be idle before being released. The default value is set to 10000|
|24||conn_acquire_time||Optional||The maximum time, in milliseconds, that pool will try to get the connection before throwing error. The default value is set to 10000|
|PERSIST LICENSE SETTINGS FOR DOCKER/VM|
|25||license_key||Optional||Valid Skedler license key.|
|26||license_email_id||Optional||Valid email id provided during initial activation|
To increase the search count in the generated excel report, the heap memory of Skedler needs to be increased. Uncomment the variable and set the value in a megabyte. Ideally, its set as when memory size is 1024, the maximum search count max will be 10000, similarly when the memory size is 2048 search count max will be 10000, and so on.
|28||dashboardTimeOut||Optional||wait time to load the dashboard for kibana/grafana. Default is 180000|
|29||SSO||Optional||For enabling Active Directory to uncomment the sso and change the value true, Default: false|
|30||ssoType||Optional||For OpenIDConnect uncomment the ssoType. (Currently, we support only OpenID connect)|
|31||identityMetadata||Optional||uncomment the identity metadata and replace the <tenantID> with your tenantID|
|32||clientID||Optional||Specify your clientid from Active Directory|
|33||redirectUrl||Optional||Specify your redirect URL which you have mentioned in Active Directory. ForExample: https://localhost:3000/skedler/login|
|34||destroySessionUrl||Optional||Specify your destroy session Url|
|1||quality||Optional||You can set the quality of the image between a range of 0 to 100. Default quality 0.|
Note: As the quality increases the generated PNG size increases
|2||workerCount||Optional||ReportEngine is scaled as per the CPU cores in the system and is configurable using the workerCount variable.|
Ideally, its set as n/2, where n is the number of CPU cores.
The default value is set to 1.
|3||workerDeath||Optional||Number of times to reuse the phantom/chromium instance.|
The default value is set to 1.
|4||pageTries||Optional||Number of tries to load the report generation URL.|
|5||pageCount||Optional||Number of pages analysed concurrently by the same phantom instance.|
The default value is set to 1. (recommended)
|6||pageDeath||Optional||Timeout for the report generation process to wait for a report to be generated. The default value is set to 600000. (recommended)|
|7||puppeteerFlags||Optional||Options to load the report engine browser(Chromium) like web security, ssl, proxy.|