Introduction

Skedler-Alerts v3.1.0 is now available in the Docker repository. It simplifies the installation process and shortens the time to get Skedler-Alerts up and running.   


Pre-requisites

System Requirements

  • Minimum of 4 CPU cores and 8 GB of RAM is recommended for deploying Skedler-Alerts.
  • Docker version greater than 1.8.0 should be installed.
  • Skedler-Alerts v3.1 or higher is only supported.


Step-by-Step Instruction

Step 1: Pull Skedler-Alerts from a Docker Repository

  • Obtaining Skedler-Alerts for Docker is a simple as issuing a docker pull command.
  • The Docker image for Skedler-Alerts 3.1 can be retrieved with the following command 

            sudo docker pull skedler/alerts:latest


Step 2: Start Skedler-Alerts as a Container

  • To start skedler-alerts as a container use the following command 

           sudo docker run --name alert -t -d -v alertdata:/data -p 0.0.0.0:3002:3001 skedler/alerts /bin/bash

Note: 0.0.0.0 is the bind address in which Skedler-Alerts runs, 3002 is the Host IP port which Skedler-Alerts uses and 3001 is the Docker IP port


Step 3: Basic Skedler-Alerts configurations using alertconfig.yml


To configure (or) edit Skedler-Alerts configurations like port, Elasticsearch URL and alert_index use the following command

         sudo docker exec -it alert nano /data/alertconfig.yml

  • port - The port in which skedler runs. Default port is 3001
  • elasticsearch_url - Elasticsearch URL with the port (even if the port is 80) in the following format <protocol>://<server>:<port>

  • alert_index - Skedler-Alerts index which will be created in Elasticsearch. It will create a new index if it doesn't already exist. Default skedler_index is .alert

Note: For more configuration options kindly refer the article alertConfig.yml in Skedler-Alerts Install Guide


Step 4: Run Skedler-Alerts as container

  • To run skedler-alerts as a container sudo docker exec alert service alert start
  • To stop skedler-alerts sudo docker stop alert


Step 5: Accessing Skedler-Alerts

  • Skedler-Alerts can be accessed from the following URL if it is using the port 3001. http://<hostIP>:3001
  • For example, if the HostIP: 192.168.0.101 and Docker IP: 172.17.0.1 respectively. Skedler-Alerts runs in 172.17.0.1 and you can access skedler-alerts using HostIP in the browser. http://192.168.0.101:3001


Step 6: Activate License Online

Skedler-Alerts is available in the following editions:

  • Licensed Editions

    • Standard Edition

    • Free Trial Edition – with the same features as the Standard Edition and a complimentary license key valid for 21 days. When the free trial period expires, Skedler-Alerts cannot be scheduled.

Once Skedler-Alerts is installed, to schedule Skedler-Alerts activate one of the Licensed Editions including the Free Trial, you must activate a valid license key. You would receive the license key along with the product download information. If you have any questions or need help with the license key, contact us at support@skedler.com.


 Note:  License keys can be activated using Online Activation or Offline Activation. If your server doesn’t have internet connection, please refer to Step-by-Step Guide for Offline License Activation of Skedler-Alerts


  • To activate the license, click the About icon in Skedler Homepage.

 

  • Click Activate License.

 

  •  The License Activation page is displayed.

  • Enter the required values in the Name, Email, and Company field.

  • By default, a trial license key is auto-populated in the “License Key” field. If you own a Product license key, update the License key field.   


If the Internet connection requires a proxy server, click Proxy Setting in the License Activation page to enter the details. Specify the protocol, server name or proxy IP, and port. If the proxy setting requires user authentication, enter the username and password in the Username and Password fields.



Specify the protocol, server name or proxy IP, and port. If the proxy setting requires user authentication, enter the username and password in the Username and Password fields.

  • Click Save button. The License Activation page is displayed.
  • Read and select I agree to the Terms and Conditions checkbox.
  • Click Online Activation to activate the Skedler-Alerts Trial License.




Note: Do not modify the License key unless you update the Skedler Edition


Step 7: Configure Timezone, Index Pattern, Email and Webhook


To schedule Skedler-Alerts timezone, index-pattern with Email or Webhook settings needs to be configured.

  • Update time zone for scheduling the alert. Click Save to update the details.

                         


  • In order to use Skedler-Alerts you must configure at least one index pattern. Index patterns are used to identify the Elasticsearch index to schedule alerts.
  • Selecting "Refresh Indices by schedule" will allow you to refresh fields of Index pattern frequently



  • If you do not want your alerts to be mailed, you can toggle  Off to disable the mail settings.
  • If you want the alerts to be emailed, configure the outgoing mail settings and email id (from which all the reports will be sent). If the SMTP server has authentication, select the Use Password checkbox and enter the password in the Password field. Click Save to save the configuration details.





You are now ready to start scheduling Alerts. Refer to Step-by-Step User Guide for Skedler-Alerts to create alerts. 



References