This page explains how to install Skedler Reports v5 dependencies, download and install Skedler v5, get the service up and running on your macOS system, and also describes the installation package details.


Install Pre-requisites

sudo xcode-select --install

Install .tar.gz package

Download the latest Skedler .tar.gz file and extract it.

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

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.  

Read more about the reporting.yml configuration options.  


Start Skedler

To run Skedler manually, the command is:

sudo bin/skedler

When you start Skedler, you will see permission errors in Terminal and will be prompted for permission. You need to give access for each process(Node.js, SQLite, Chromium) by selecting allow anyway in  System Preferences → Security & Privacy → General.  You will be prompted multiple times.  At each step, do the following:

  • Stop Skedler using Ctrl + c
  • Give permission by going to System Preferences → Security & Privacy → General and selecting allow anyway or open the application if prompted.
  • Kills redis by using sudo kill $(pgrep -i redis)
  • restart Skedler
  • Repeat the steps until no more errors are seen and you are able to login and activate Skedler license.

Also note that while executing bin/skedler in a new macOs machine it might prompt to install some packages globally


After a successful installation, you will see the URL for accessing Skedler in the terminal.


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