In this article, we will look into how to upgrade from Skedler version 4.x to the latest 5.x in Ubuntu or Debian environments. 


Note: Install Skedler v5 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.    

Install Pre-requisites

sudo apt-get -y update
sudo apt-get install -y libfontconfig1 libxcomposite1 libxdamage1 libcups2 libasound2 libxrandr2 libxfixes3 libnss3 libnss3-dev libxkbcommon-dev libgbm-dev libxshmfence-dev libatk1.0-0 libatk-bridge2.0-0 libgtk-3-0 gcc make

Install Skedler v5 .deb package

Download the latest skedler-xg.deb file and extract it.  

curl -O https://skedler-v5-releases.s3.amazonaws.com/downloads/latest/skedler-xg.deb
sudo dpkg -i skedler-xg.deb

Install Skedler v5 .tar.gz package

If you prefer to install using the .tar.gz package, download the latest skedler-xg.tar.gz file and extract it.

curl -O https://skedler-v5-releases.s3.amazonaws.com/downloads/latest/skedler-xg.tar.gz
sudo tar xzf skedler-xg.tar.gz
cd skedler-xg
sudo chmod -R 777 *


Configure reporting.yml

To configure the upgrade settings edit the reporting.yml file in the skedler-xg folder.

For .tar.gz 

sudo nano reporting.yml

For .deb 

sudo nano /usr/share/skedler-xg/reporting.yml



Configure the following required information in the reporting.yml.  These parameters are required for upgrading from Skedler 4.x to 5.x:

  • oldSkedlerBasePath - The absolute path to your Skedler Reports 4.x.  This path should be accessible from the v5 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 databse 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.
    • migrationDatabaseHost

    • migrationDatabasePort

    • migrationDatabaseName

    • migratoinDatabaseUsername

    • migrationDatabasePassword

    • migrationDialect

  • 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.

Start migration

After configuring the reporting.yml file, start the upgrade process.  

For .tar.gz 

sudo bin/migrate

For .deb

cd /usr/share/skedler-xg
sudo bin/migrate

Start Skedler for .deb


To start Skedler, the command is:

sudo service skedler start

To check status, the command is:

sudo service skedler status

To stop Skedler. the command is:

sudo service skedler stop

Start Skedler for .tar.gz 

To run Skedler manually, the command is:

sudo bin/skedler


To run Skedler as a service, the commands are:

sudo ./install_as_service.sh

To start Skedler, the command is:

sudo service skedler start

To check status, the command is:

sudo service skedler status

To stop Skedler. the command is:

sudo service skedler stop

Access Skedler Reports

The default URL for accessing Skedler Reports v5 is:

http://localhost:3005/ 

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 

or 

http://<hostname or your domain url>:<port number>

Login to Skedler Reports


Sign in using the following credentials:


Default username: admin@skedler.com
Default password: admin 


Click Sign in.  


Next step: Proceed to License Activation