In this article, we will look into how to upgrade from Skedler version 4.x to the latest version in Windows environments.
Note: Install Skedler in a new(separate) folder on the same machine as your Skedler v4 environment. Do not overwrite your Skedler v4 environment so that you can still run your Skedler v4 if there are any problems with the upgrade.
Download the zip file of Skedler Reports.
Unzip the skedler.zip file. You will see the skedler-xg folder.
Open Windows PowerShell in Run as Administrator mode and navigate to the Skedler package.
Configure your options for migration
To configure the migration settings edit the reporting.yml file in the skedler-xg folder using Notepad. Configure the following required information in the reporting.yml. These parameters are required for upgrading from Skedler 4.x to the latest version:
- oldSkedlerBasePath - The absolute path to your Skedler Reports 4.x. This path should be accessible from the Skedler environment.
- migrationSourceDatasource - The database that you are using in Skedler Reports 4.x. The values can be ‘elasticsearch’, ‘mysql’, ‘sqlite'.
- migrationSourceDatastorePath - If you were using sqlite as the database in v4, enter the path to your Skedler Reports 4.x sqlite database.
- Enable and configure the below variables only if you used mysql as the database in Skedler Reports 4.x.
- Enable and configure the below variables only if you used elasticsearch as the database in Skedler Reports 4.x.
elasticsearchUrl - The Elasticsearch url configured in Skedler v4.x
skedlerIndex - The Elasticsearch index configured in Skedler v4.x
elasticsearchAuthType - The authentication type, if any, for the configured Elasticsearch.
skedlerElasticsearchUsername - Enable and configure if authentication is present.
skedlerElasticsearchPassword - Enable and configure if authentication is present
In addition, you can configure other options to run Skedler in an air-gapped environment, change the port number, define the hostname, change the location for the Skedler database, and log files. Read more about the reporting.yml configuration options.
Save the reporting.yml file and exit the editor.
After configuring reporting.yml file. Start the upgrade
Start Skedler manually
In the terminal start skedler manually by executing the following command from $skedler_home.
Start Skedler as service
Run install_as_service.bat file from $skedler_home folder by using the following command:
To start the application as a service execute the following command from $skedler_home:
To stop Skedler Reports as service execute the following command from $skedler_home,
To restart the application as a service execute the following command from $skedler_home:
Access Skedler Reports
The default URL for accessing Skedler Reports is:
If you had made configuration changes in the reporting.yml, then the Skedler URL is of the following format:
http://<hostname or your domainurl>:3005
http://<hostname or your domain url>:<port number>
Login to Skedler Reports
Sign in using the following credentials:
Default username: email@example.com
Default password: admin
Click Sign in.
Next step: Proceed to License Activation