Step1: Verify Pre-requisites for Windows Installation

System Requirements

  • We recommend installing Skedler Reports in a separate VM or Docker container or server.
  • Windows operating system - 64bit
  • Minimum of 2 CPU cores and 8 GB of RAM is recommended for deploying Skedler Reports.


NOTE: It is not recommended to run Skedler Reports in a 32bit Operating System 


Elasticsearch and Kibana version

Skedler Reports supports Elasticsearch version from 5.x to 6.3 and Kibana version from 5.x to 6.3 and Grafana 4.x to 5.2

Step 2: Download

  • Download the latest version of Skedler Reports from Download page

Step 3: Extract

  • Extract the skedler.zip file to the desired folder (e.g., C:\\Skedler).

Step 4: Configure Permission

  • Change the current directory (or go) to the folder where skedler.zip was extracted. For convenience, let us call this folder as $skedler_home.
  • Provide read/write permissions to the following folders.
    • $skedler_home\log
    • $skedler_home\reports
    • $skedler_home\src\preview

Step 5: Configure reporting.yml

  • Go to config folder using the command cd config.
  • Open reporting.yml.

ElasticSearch and Kibana  URL configuration
  • Add Elasticsearch URL with the port (even if the port is 80) and the Kibana URL with the port in the reporting.yml file in the following format <protocol>://<server>:<port>


v2F6cMicWVTqOeOIjhlVCHMghrDXYa24hg.png




 Grafana URL configuration

  • For Skedler Reports to discover Grafana dashboards and generate the report for Grafana you would need to configure Grafana details in reporting.yml. By default, the Grafana configuration variables are commented in the reporting.yml. Uncomment the variables and assign the Grafana URL with the port and the Grafana authentication credentials or the Grafana authentication token key to access the dashboard.


  • If you are using Nginx or SearchGuard, follow the steps below. 

Note: If you are using Shield then refer to Step-by-Step Configuration Guide for Shield.


  • If Kibana is configured behind Nginx, configure the Nginx username and password for Kibana in reporting.yml as shown:06piJZlmmMjiWvpKl6eSrxdiZcB8cJBWNg.png
  • If Nginx is configured as a reverse proxy for elasticsearch, configure Nginx username and password for elasticsearch as shown:b2A7Blm75s_NryNYhIWDRtwpXlVVddrUDQ.png
  • Save changes to reporting.yml
For more configuration options please refer Reporting.yml and ReportEngineOptions Configuration.

Step 6: Start Skedler Reports

Starting Skedler Reports manually
Start the application from $skedler_home folder by using the command bin\skedler.bat

Starting Skedler Reports in debug mode
bin\skedler.bat debug


To Start the application as service run the following command from $skedler_home

Start Skedler Reports as service

bin\skedlersevice.bat start

 

To stop Skedler Reports as service

bin\skedlersevice.bat stop



Step 7: Access Skedler Reports

Skedler Reports can be accessed from the following URL http://<yourServer>:3000.  The License Activation page is displayed on successful installation.


Step 8: Configure Skedler Reports Settings

To configure Skedler Reports settings refer the How to configure email settings, time zone settings and default logo for reports


You are now ready to start scheduling Reports. 


Refer to How to create and schedule a report based on Kibana dashboard to create reports. 


Step 9: License Upgrade

Activation is required for purchased product license key. In the Community Edition, license activation will be skipped. If you purchase Skedler Reports license, you will receive a license key by email.  


Refer to Upgrade License


References