Step1: Verify Pre-requisites

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
  • 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
  • Font config library

    • Debian/Ubuntu – sudo apt-get install libfontconfig

Hostname Configuration

Skedler Reports require 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, Grafana version and Open Distro For Elasticsearch

  • Elasticsearch: 5.x – 7.4.x

  • Kibana: 5.x – 7.4.x

  • Grafana: 5.x – 6.4.x

  • Open Distro for Elasticsearch: 0.8.0 - 1.2.0

Step 2: Download

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

Step 3: Install Skedler Reports

Install Skedler Reports deb package using the below command,

sudo dpkg -i  skedler-reports.deb

NOTE: After the deb package installation, if you would like to remove Skedler Reports deb package use the below command:

sudo dpkg -r skedler-reports


Step 4: Directory Layout

The Debian package places config files, script files, and the logs directory in the appropriate locations for a Debian-based system:


Type
Description
Default Location
home
Skedler Reports home directory or $skedler_home
/usr/share/skedler-reports
bin
Binary scripts to start Skedler Reports server
/usr/share/skedler-reports/bin
conf
Configuration file reporting.yml
/etc/skedler-reports
logs
Log files location.
/var/log/skedler-reports
Database
Embedded database to store Skedler metadata and history data
/var/lib/skedler/skedler.db and /var/lib/skedler/skedlerHistory.db


Step 5: Configure reporting.yml

Configure Skedler configurations like hosts configuration, admin user configuration, SSL settings and Datastore configuration in /etc/skedler-reports/reporting.yml

To edit the configuration file sudo nano  /etc/skedler-reports/reporting.yml

Refer reporting.yml configuration option

Step 6: Start Skedler Reports

  • To automatically start Skedler Reports when the system boots up, run the following commands,   
sudo systemctl daemon-reload
  • To start Skedler Reports, execute the command as shown below,          
sudo systemctl start skedler-reports
  • To stop Skedler Reports, execute the command as shown below,                 
sudo systemctl stop skedler-reports


Step 7: Access Skedler Reports

Once launched, Skedler Reports can be accessed from the following URL, http://<yourServer>:3000

Step 8: Configure Skedler Reports Settings

To configure Skedler Reports settings refer the How to configure Datasource and Notification Channel details.

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 the purchased product license key. If you purchase a Skedler Reports license, you will receive a license key by email.  

Once Skedler has launched it operates in Enterprise trial with a validity of  21 days. Once the Enterprise trial expires, the product moves to Community Edition and operate withs by limited functionality.

Refer to Upgrade License

Reference