Step1: Verify Pre-requisites for Linux Installation

System Requirements

  • We recommend installing Skedler Reports in a separate VM or Docker container or server.
  • Linux Operating System with x86-64-bit architecture
    • Ubuntu version 12.04 and above
    • Debian version 7 and above
    • Centos version 6  and above
    • Red Hat Enterprise Linux 6 and above
  • Minimum of 2 CPU cores and 8 GB of RAM is recommended for deploying Skedler Reports

Library Dependencies

  • libnss3 library


    • Debian/Ubuntu – sudo apt-get install libnss3
    • CentOS/RedHat – sudo yum install libnss3.so libnssutil3.


  • Font config libraries

    • Debian/Ubuntu – sudo apt-get install libfontconfig
    • CentOS/RedHat – sudo yum install fontconfig



Hostname Configuration

Skedler Reports requires hostname of the server in which Skedler Reports is installed to be configured in /etc/hosts.

1.  Check hostname by giving this command: 

     $>hostname   

In reporting.yml the host parameter is the host in which skedler reports binds.

2.  If the host is configured as 127.0.0.1 then make sure you have an entry in /etc/hosts as mentioned below,

     127.0.0.1 localhost

     Note: If you are binding skedler reports to localhost you can't access it from outside.      

3. However. If the bind address is 0.0.0.0, that means skedler reports binds to any IP (configured for your system). In this case, your entry in the host's file(/etc/hosts) should be

    <ipaddress> <hostname>

4.  If the host(IP address of the server) in reporting.yml is changed other than the default value 0.0.0.0 then there should be an entry for the host in /etc/hosts like

     <ipaddress> <hostname>

 5.  Reboot the system.

       

Note: If you are using any proxy server add your hostname to a no_proxy list in the file /etc/environment add the following line,

           no_proxy="<ipaddress>,<hostname>"


 Elasticsearch, Kibana and Grafana version

Skedler Reports supports Elasticsearch version from 5.x to 6.6.x, Kibana version from 5.x to 6.6.x and Grafana 4.x to 5.4.x


Step 2: Download

  • Download the latest version of Skedler Reports from Download page.


Step 3: Extract


  • Untar the skedler.tar.gz file to the desired folder (e.g., /opt). For convenience, let us call this folder as $skedler_home.


Step 4: Configure reporting.yml


  • Go to config folder using the command cd config.
  • Open reporting.yml (e.g., vi /opt/skedler/config/reporting.yml) 

      

      Enabling SSL for Skedler Reports and Elasticsearch refer to  Enabling SSL  



      ElasticSearch and Kibana  URL configuration

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

    UjokHQ7W7-G0MffXOAYKpKUOyf7J5fSTEA.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. If you have enabled anonymous access in Grafana set the variable grafana_anonymous_access as true. 
  • Note: You can configure the variable grafana_auth_token_key in Skedler v3.9.2 and below.


Step 5: Install Skedler Reports

  • Provide the required permission to install.sh in $skedler home script file using the command
  • cd $skedler_home
  • sudo chmod u+x install_as_service.sh
  • Install Skedler Reports using the below command. Run install.sh as sudo user

             sudo ./install_as_service.sh


Step 6: Start Skedler Reports

Starting Skedler Reports manually

Start the application from $skedler_home folder by using the command bin/skedler


Starting Skedler Reports in debug mode
bin/skedler debug


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

Start Skedler Reports as service

sudo service skedler start

 

To stop Skedler Reports as service

sudo service skedler 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