Introduction
Welcome to the getting started guide for Skedler Reports Plugin. We will go through the key steps required to install and setup Skedler Reports plugin, and generate automated reports.
Prerequisite
On-premise application of Skedler Reports should be up running. Refer Skedler Reports Installation Guide
Installation
If the server in which you are installing Skedler Reports plugin has an internet connection, use Online Installation. If the server in which you are installing Skedler Reports plugin does not have an internet connection, use Offline Installation.
Online Installation
Copy the URL of the Skedler Reports plugin matching your exact Kibana version from here.
Stop Kibana
Goto Kibana installation directory, consider Kibana installation directory as $kibana_home
Execute the command as shown below:
For Linux,
bin/kibana-plugin install https://www.skedler.com/plugins/skedler-reports-plugin/skedler-reports-kibana-plugin-<kibana_version>-<skedler_reports_plugin_version>.zip
For example, if the Kibana v7.4.2 and Skedler Reports plugin v4.7.0,
bin/kibana-plugin install https://www.skedler.com/plugins/skedler-reports-plugin/skedler-reports-kibana-plugin-7.4.2-4.7.0.zip
For Windows,
bin\kibana-plugin.bat install https://www.skedler.com/plugins/skedler-reports-plugin/skedler-reports-kibana-plugin-<kibana_version>-<skedler_reports_plugin_version>.zip
For example, if the Kibana v7.4.2 and Skedler Reports plugin v4.7.0,
bin\kibana-plugin.bat install https://www.skedler.com/plugins/skedler-reports-plugin/skedler-reports-kibana-plugin-7.4.2-4.7.0.zip
Offline Installation
You can download the Skedler Reports plugin matching your exact Kibana version from here.
Stop Kibana
- Goto Kibana installation directory, consider Kibana installation directory as $kibana_home
Execute the command as shown below:
For Linux,
bin/kibana-plugin install file:///some/local/path/skedler-reports-kibana-plugin-<kibana_ version>-<skedler_reports_plugin_version>.zip
For example, if the Kibana v7.4.2 and Skedler Reports plugin v4.7.0,
bin/kibana-plugin install file:///opt/local/skedler-reports-kibana-plugin-7.4.2-4.7.0.zip
For Windows,
bin\kibana-plugin.bat install file:\\\some\local\path\skedler-reports-kibana-plugin-<kibana_version>-<skedler_reports_plugin_version>.zip
For example, if the Kibana v7.4.2 and Skedler Reports plugin v4.7.0,
bin\kibana-plugin.bat install file:\\\C:\source\skedler-reports-kibana-plugin-7.4.2-4.7.0.zip
Configuration
Once the Skedler Reports plugin is installed, configure the Skedler Reports URL to connect to the Skedler Reports server.
- Goto Kibana installation directory, consider Kibana installation directory as $kibana_home
- cd $kibana_home/plugins/skedler/config
- To edit the configuration file skedler_reports.yml, run the command below:
For Linux, sudo nano $kibana_home/plugins/skedler/config/skedler_reports.yml
For Windows, Open skedler_reports.yml file using Wordpad or Notepad
URL Configuration
Configure the Skedler Reports server URL in the skedler_reports_url variable. By default, the variable is set as shown below,
skedler_reports_url: “http://localhost:3000”
Basic Auth Configuration
If the Skedler Reports server URL requires basic authentication, For example, Nginx, uncomment and configure the skedler_username and skedler_password with the basic authentication credentials as shown below:
skedler_username: <user>
skedler_password: <pass>
Start Kibana
Start Kibana, it will start optimizing and caching browser bundles. This process may take a few minutes and cannot be skipped. After the plugin is installed and optimized, Kibana will be up running.
Access Skedler Reports Plugin
In the Kibana home page, you will find the Skedler Reports in the left panel as shown below,
Click on the “Skedler Reports” to access Skedler Reports UI
Proceed to the steps outlined below in the Basic Setup section.