How to Persist Skedler in VM, Docker/Container Environments

Modified on Mon, 31 Oct 2022 at 09:01 AM

During the upgrade, migration, or recreation of the Skedler VM or container, you can persist the license key and data from your existing Skedler installation and reuse them in the new Skedler environment.  

License Persistence

To avoid manual activation of the Skedler license after upgrade or migration, uncomment the following keys and add the email id and license key to the reporting.yml file.  Skedler will automatically activate the license during the start.  

  • licenseKey - A valid Skedler reports license key.
  • licenseEmail - A valid email id that you had used in your initial activation of the Skedler Reports

Skedler will automatically reactivate the license during the start.  

Data Persistence

To persist Skedler data and configuration, you need to persist the following:

  1. reporting.yml
  2. Skedler database
  3. Asset files
  4. Log files (this is optional)

Please find below detailed information on each of the above components:

  • reporting.yml -  This contains the configuration information for Skedler.  The location for reporting.yml is given below for various install packages:
    • .tar.gz : $skedler-xg/reporting.yml (skedler-xg home directory)
    • .deb and .rpm : /usr/share/skedler-xg/reporting.yml
  • Skedler database- By default Skedler uses SQLite as the internal database.  The SQLite database is located in the following location which must be persisted:  
    • Linux:  /var/lib/skedler-xg
    • Windows: c:/skedler-xg-system-files

            The databasePath parameter in reporting.yml can be customized to modify the location of the database.  


            Optionally, you can use an external MySQL instance as the database for Skedler.   If you use an external MySQL instance,  you can ignore the database persistence requirement. 

  • Asset files- Asset files consist of images and JSON files used for rendering reports.  The asset files are located in
    • Linux:  /var/lib/skedler-xg
    • Windows: c:/skedler-xg-system-files
  • Log files - Persisting log files is optional.  The logFilesDir parameter in reporting.yml can be customized to modify the location of log files. The default location for log files is given below:
    • Linux: /var/opt/skedler-xg
    • Windows: c:/skedler-xg-system-files

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons

Feedback sent

We appreciate your effort and will try to fix the article