- We recommend installing Skedler Reports 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 Reports.
NOTE: It is not recommended to run Skedler Reports in a 32bit Operating System
Skedler Reports supports Elasticsearch version from 5.x to 7.5.x, Kibana version from 5.x to 7.5.x and Grafana 5.x to 6.5.x
- skedler.zip was extracted. For convenience, let us call this folder as $skedler_home.
- Provide read/write permissions to the following folders.
- Go to 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
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
To Start the application as service run the following command from $skedler_home
Start Skedler Reports as service
To stop Skedler Reports as service
Skedler Reports can be accessed from the following URL http://<yourServer>:3000.
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.
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
- 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