This page explains how to install and run Skedler Reports v5 docker image.

Note on upgrading: The process for upgrading Skedler Reports from v4 to v5 is very similar to installing Skedler Reports v5, there are some key backup steps you should perform. Read Upgrading Skedler Docker Image for tips and guidance on updating an existing installation.

Pull the latest version of Skedler v5 from the docker repository and run the image.

sudo docker pull skedler/onprem:latest
sudo docker run --name skedler-xg -t -d -v skedlerdata:/var/lib/skedler-xg -p 0.0.0.0:3005:3005 skedler/onprem /bin/bash

Start Skedler using the following commands.

sudo docker exec skedler-xg service skedler start
sudo docker exec skedler-xg /usr/share/skedler-xg/bin/skedler container

You are now ready to Access Skedler Reports.  Proceed to the Access Skedler Reports section.


Configure your options for Skedler v5

Skedler Reports has a number of configuring options that can be defined in its reporting.yml file (located in the skedler folder).  In the reporting.yml file, you can configure 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.  

sudo docker exec -it skedler-xg nano /usr/share/skedler-xg/reporting.yml

Read more about the reporting.yml configuration options.  


Upgrading Skedler Docker image

If you are upgrading from a previous version of Skedler v5,  you need to do a couple of things before upgrading your docker image.  

  1. Backup Skedler data located in /var/lib/skedler-xg folder
  2. Backup reporting.yml located in the skedler-xg home.  

After taking a backup,  proceed to update the docker image and start skedler.  

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


By default, you will see the Create an account UI.  Enter your email to create an administrator account in Skedler Reports. Click on Continue.  


Note: If you have configured an email address and password in reporting.yml, then you can skip the create account step and proceed to Login.  



An account will be created and you will be redirected to the Login page.  


Sign in using the following credentials:


Username: <your email address>   (or the email address you configured in reporting.yml)
Password: admin   (or the password you configured in reporting.yml)


Click Sign in.  



You will see the Reports Dashboard after logging in to the skedler account.   

Next step: Proceed to License Activation.