Step1: Verify Pre-requisites for Windows Installation

System Requirements

  • We recommend installing Skedler 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.

Configure environment variables JAVA_HOME and PATH

  • Configure Java_Home as User Variable.

pIeoZNA2hYJqaWAVe45cU1bFlidcIwvBMw.png

  • Add JAVA_HOME\bin to PATH

O8zi_pAEEjSqTP2dJ8O_L80UVdO4ESXwEQ.png

  • Add JAVA_HOME\jre\bin\server to PATH

suDL-PGNoXyCpvxcH72WMqmuQ88H3LHPLA.png


Windows dpi settings

Dpi setting in Windows should be set to 96dpi for Skedler to generate the report in an aligned manner. By default, the value is set at 96dpi.

 

Go to Control Panel > Appearance and Personalization > Display to check the dpi settings.

2ZFldl5qrGmpCGMxeED5HvrfpS59Q2Mopg.png


Elasticsearch and Kibana version

Skedler supports Elasticsearch version from 1.7 to 5.6.1 and Kibana version from 4.1 to 5.6.1

Step 2: Download

  • Download the latest version of Skedler from Free Trial page

Step 3: Extract

  • Extract the skedler.zip file to the desired folder (e.g., C:\Program Files\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
    • Report folder configured for reports_dir parameter in reporting.yml

    • UI files folder configured for the parameter ui_files_location


Step 6: 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 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 7: Start Skedler

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

Starting Skedler in debug mode
bin\skedler.bat debug


Start Skedler as service

bin\skedlersevice.bat start

 

To stop Skedler as service

bin\skedlersevice.bat stop


Step 8: Access Skedler

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

Step 9: Activate License Online


To activate Skedler (in Free Trial or Licensed) you must activate a valid license key.  A trial license key is automatically populated in the license activation form.  If you purchase Skedler license, you will receive a license key by email.  


License keys can be activated using Online Activation or Offline Activation.  However, Free Trial license key requires Online Activation.  If your server doesn’t have internet connection, please refer to Step-by-Step Guide for Offline License Activation of Skedler.



1. Click Activate License.


2.  The License Activation page is displayed.A_QLox9NP4eaaFYlnQFJXsO2mFPAw8ee2Q.png

3. Enter the required values in the Name, Email, and Company field.


ykKQcDxVKA4RHwT1GFGw4RNO0XR_tl1m3Q.png

By default, a trial license key is auto-populated in the “License Key” field. If you received a Product license key, update the License key field. 


4. If the Internet connection requires a proxy server, click Proxy Setting in the License Activation page to enter the details. Specify the protocol, server name or proxy IP, and port. If the proxy setting requires user authentication, enter the username and password in the Username and Password fields. Click Save button. The License Activation page is displayed.

B4jkZPERM1BhOcjsrJ3tm56j4GobuO1zKg.png


5. Read and select I agree to the Terms and Conditions checkbox.

6. Click Online Activation to activate the Skedler Trial License.

E4reSxfu9FwLjoR5s9TAZHxnvimu9O4SnQ.png



Step 10: Configure Skedler Settings

To configure Skedler 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 Skedler v2.8.1 User Guide for Windows or Skedler v3.x How to create and schedule a report based on Kibana dashboard to create reports. 



References