Skedler has two configuration files

  • reporting.yml in $skedler_home/config folder
                    Used t configure Skedler configuration like Elasticsearch URL, Kibana URL, Security credentials, host configuration etc.,
  • reportingEngineOptions in $skedler_home/config folder
                    Used to configure Skedler report generation options like scaling options, Phantom Flags etc.,

reporting.yml CONFIGURATION

BASIC SETTINGS


S. NoNameMandatory/OptionalDescription
1elasticsearch_urlMandatoryThe Elasticsearch instance to use for all your queries.
2kibana_url / grafana_urlMandatoryKibana/Grafana URL specification.
KIBANA SECURITY SETTINGS
3securityOptionalIf Security plugin is configured in Elasticsearch/Kibana - xpack/searchguard/readonlyrest, then uncomment and configure the security variable as xpack or searchguard or readonlyrest.
4ESsecurity_user_loginOptionalIf Elasticsearch is configured with the security plugin, and if Elasticsearch has security users created, then us can use the security users to login Skedler. User-based reports will be created. To enable Elasticsearch security users in Skedler uncomment and set this variable as `yes`.
5skedler_elasticsearch_username
skedler_elasticsearch_password
OptionalIf Elasticsearch uses security or basic auth, add the security username and password here for Skedler.
6kibana_elasticsearch_username
kibana_elasticsearch_password
OptionalIf Elasticsearch uses security or basic auth, add the security username and password here for Kibana.
NGNIX SETTINGS
7skedler_nginx_kibana_username
skedler_nginx_kibana_password
Optional

If Kibana is behind Ngnix, configure Ngnix username password.
8skedler_nginx_elasticsearch_username
skedler_nginx_elasticsearch_password
OptionalIf Elasticsearch is behind Ngnix, configure Ngnix username password.
GRAFANA SETTINGS
9grafana_authenticationOptionalIf have authentication to access the dashboard, uncomment and set the variable as yes.
10skedler_grafana_username
skedler_grafana_password
OptionalIf Grafana has authentication to access the dashboard, add the username and password.
11grafana_anonymous_accessOptionalIf you have enabled anonymous access in Grafana set the variable as true.
12grafana_auth_token_keyOptionalIf Grafana has an authentication token key to access the dashboard, add the token key.
Note: You can configure the variable in Skedler v3.9.2 and below


ADVANCED SETTINGS


S. NoNameMandatory/OptionalDescription
HOST SETTINGS
1portOptionalPort in which Skedler runs.
Default port is 3000.
2hostOptionalThe 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
127.0.0.1 <hostname>
3basePathOptionalEnables 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.
INDEX SETTINGS
4skedler_indexOptionalSkedler index which will be created in elasticsearch. It will create a new index if it doesn't exist.
Default Skedler index is .skedler
5kibana_indexOptionalSkedler uses this index to auto discover dashboard.
Default Kibana index is .kibana.
Note: Skedler will not create this index.
REPORT SETTINGS
6ui_files_locationOptionalWhen 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.
7log_dirOptional

Enables you to specify a folder where Skedler stores the log output. 

Default log output directory $skedler_home/log.

8browserOptionalSpecifies whether Skedler report generation browser to be chromium or phantom. Default value is set as phantom.
ELASTICSEARCH CONNECTION SETTINGS
9search_limitOptionalSearch limit is the number of rows to show in the search table. Limit should be between 1 and 10000.
PDF report the max limit is 1000. If the search limit is greater than 1000, then the default value 1000 will be set.
Excel and CSV report the max limit is 10000
Default value is 10.
10enable_elasticsearch_ssl: true
elasticsearch_ssl_certificate
elasticsearch_ssl_key
OptionalOptional 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.
11elasticsearch_ssl_certificateAuthoritiesOptionalOptional setting that enables you to specify a path to the PEM file for the certificate authority for your Elasticsearch instance.
12elasticsearch_ssl_verificationModeOptionalTo disregard the validity of SSL certificates, change this setting's value to 'none'.
13pingTimeoutOptionalTime in milliseconds to wait for Elasticsearch to respond to pings. This must be > 0.
14requestTimeoutOptionalTime in milliseconds to wait for responses from Elasticsearch. This must be > 0.
KIBANA CONNECTION SETTINGS
15kibana_display_urlOptionalKibana Display URL specification
16kibana_display_iconOptionalEnables to display Kibana icon in Skedler menu.
Default value is set to no.
SKEDLER REPORT SSL SETTINGS
17server_ssl_enabled
server_ssl_certificate
server_ssl_key
OptionalEnables 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.
DATABASE SETTINGS
18database_typeOptionalSpecify the database type either "mysql" or "sqlite"
19database_hostname
database_port
database_name
database_history_name
database_username
database_password
Optional


For `mysql` database configuration, you can configure the database connection by specifying host, name, user and password.
20database_path
database_history_path
OptionalFor `sqlite` database configuration, you can specify the relative path.
21max_connOptionalMaximum number of connection in pool. Default value is set to 5
22min_connOptionalMinimum number of connection in pool. Default value is set to 0
23conn_idle_timeOptionalThe maximum time, in milliseconds, that a connection can be idle before being released. Default value is set to 10000
24conn_acquire_timeOptionalThe maximum time, in milliseconds, that pool will try to get connection before throwing error. Default value is set to 10000
PERSIST LICENSE SETTINGS FOR DOCKER/VM
25license_keyOptionalValid Skedler license key. 
26license_email_idOptionalValid email id provided during initial activation



reportEngineOptions CONFIGURATION


S. NoNameMandatory/OptionalDescription
1qualityOptionalYou 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

2workerCountOptionalReportEngine 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.
3workerDeathOptionalNumber of times to reuse the phantom/chromium instance.
The default value is set to 1.
4pageTriesOptionalNumber of tries to load the report generation URL.
5pageCountOptionalNumber of pages analysed concurrently by the same phantom instance.
The default value is set to 1. (recommended)
6pageDeathOptionalTimeout for the report generation process to wait for a report to be generated. The default value is set to 600000. (recommended)
7phantomPortOptionalPort series for Phantom.
8phantomFlagsOptionalOptions to load the report engine browser(Phantom) like web security, ssl, proxy.