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
- A 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 the Elasticsearch version from 5.x to 7.11.x, Kibana version from 5.x to 7.11.x and Grafana 6.x to 7.4.xStep 2: Download
Step 3: Extract
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.
Step 5: Configure reporting.yml
- Go to the config folder using the command cd config.
- Open reporting.yml (e.g., vi /opt/skedler/config/reporting.yml)
- Skedler security configuration
- To use the security plugin and therefore, the authenticated users of ELK or Grafana for user-based report creation and generation, follow the below configuration
# To use security users of ELK or Grafana for user-based report creation and generation, uncomment the variable and set the value to `false`. By default the variable value is set to `true` skedler_anonymous_access: false
Datastore configuration
Skedler needs a datastore to store Skedler metadata and history data. By default, Skedler uses Internal Database as a Datastore. Alternatively, you can configure either Elasticsearch or an external "MySQL" or "SQLite" database as a Datastore.
If you would like to use Elasticsearch as a Datastore (especially if you are upgrading from v3.x), follow the configuration shown below:
1. Add Elasticsearch URL with the port (even if the port is 80) in the reporting.yml file in the following format <protocol>://<server>:<port># The Elasticsearch instance to use for all your queries. elasticsearch_url: "http://localhost:9200"
2. If any security plugin is configured for Elasticsearch such as X-pack or Search Guard or ReadOnlyRest or Basic Auth, uncomment the variable and configure the variable with the respective value given below:# If Elasticsearch uses security or basic auth, add the security username and password here for Skedler. #skedler_elasticsearch_username: user #skedler_elasticsearch_password: pass
- On Advanced Configuration refer to the following article Reporting.yml & ReportEngine Configuration
- If you would like to use Internal Database as a Datastore, follow the configuration shown below,
Skedler uses an embedded database to store metadata and history data. The embedded database is located at,
For linux, /var/lib/skedler/skedler.db and /var/lib/skedler/skedlerHistory.db For windows, C:\skedler\skedler.db and C:\skedler\skedlerHistory.db
- Skedler security configuration
Step 6: Start Skedler Reports
To start the application as a service run the following command from $skedler_home,
bin\skedlersevice.bat start
To stop Skedler Reports as service by using the following command from $skedler_home,
bin\skedlersevice.bat stop
Step 7: Access Skedler Reports
Skedler Reports can be accessed from the following URL http://<yourServer>:3000.
Step 8: Configure Skedler Reports Settings
To configure Skedler Reports settings refer to 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 limited functionality.
Refer to Upgrade License
References
- Step-by-Step Shield Configuration Guide
- Step-by-Step Guide for Offline License Activation for Skedler
- Step-by-Step Guide to Move Skedler from One Machine to Another
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article