Steps 1: Verify Prerequisites for Linux Installation
- We recommend installing Skedler-Alerts in a separate VM or Docker container or server.
Linux Operating System with x86-64-bit architecture
- Ubuntu version 12.04 and above
- Debian version 7 and above
- Red Hat Enterprise Linux 6 and above
- Minimum of 2 CPU cores and 8 GB of RAM is recommended for deploying Skedler-Alerts
Skedler-Alerts have the dependency on libstdc++ library.
Following are the GLIBCXX versions that the code depends on
To check the versions on your server. Please run the following command
- libstdc++.so.6 (GLIBCXX_3.4.9) => /usr/lib/x86_64-linux-gnu/libstdc++.so.6
- libstdc++.so.6 (GLIBCXX_3.4.15) => /usr/lib/x86_64-linux-gnu/libstdc++.so.6
- libstdc++.so.6 (GLIBCXX_3.4) => /usr/lib/x86_64-linux-gnu/libstdc++.so.6
strings /usr/lib64/libstdc++.so.6 | grep GLIBCXX
strings /usr/lib/x86_64-linux-gnu/libstdc++.so.6 | grep GLIBCXX
If the version is not available, update the GCC compiler.
1. Check hostname by giving this command:
In alertConfig.yml the host parameter is the host in which Skedler-Alerts binds.
2. If the host is configured as 127.0.0.1 then make sure you have an entry in /etc/hosts as mentioned below,
Note: If you are binding Skedler-Alerts to localhost you can't access it from outside.
3. However. If the bind address is 0.0.0.0 in alertsconfig.yml, means Skedler-Alerts binds to any IP (configured for your system). In this case, your entry in hosts file(/etc/hosts) should be
4. If the host(IP address of the server) in reporting.yml is changed other than the default value 0.0.0.0 then there should be an entry for the host in /etc.hosts like
5. Reboot the system.
Note: If you are using any proxy server add your hostname to a no_proxy list in the file /etc/environment add the following line,
Elasticsearch and Kibana version
Skedler-Alerts supports Elasticsearch version from 1.7 to 5.4
Skedler-Alerts requires Java 7 or 8 and JAVA_HOME should be configured. Check if JAVA_HOME is configured using the following command:
> $echo JAVA_HOME
If the result is empty, follow the below steps to configure JAVA_HOME.
- For ubuntu/Debian in /etc/bash.bashrc and for Centos/Redhat in /etc/.bashrc, add the JAVA_HOME variable as follows,
export JAVA_HOME = <your_java_path>
- In /etc/environment file add the line as follows:
JAVA_HOME = "<your_java_path>"
Step 2: Download
- Download the latest version of Skedler-Alerts
Step 3: Extract
- Extract the skedler-alerts.zip file to the desired folder (e.g., /opt). For convenience, let us call this folder as $alert_home.
Step 4: Configure Permissions and JAVA_HOME
Provide read/write permissions to the following folders, if they are configured in alertconfig.yml
Skedler-Alerts folder storing JSON file configured for the alerts_path parameter in alertconfig.yml
UI files folder configured for the parameter ui_files_location
- Skedler-Alerts folder storing JSON file configured for the alerts_path parameter in alertconfig.yml
- UI files folder configured for the parameter ui_files_location
Set the value for the variable JAVA_HOME in the $_home/install.sh script as follows:
- Check JAVA_HOME using the command echo $JAVA_HOME.
- Copy and paste the output to the install.sh
- Save install.sh.
Step 5: Install Alerts
Provide the required permission to $alert_home/install.sh script file using the command
sudo chmod u+x install.sh
- Install Skedler-Alerts using the below command. Run install.sh as sudo user
Step 6: Configure alertconfig.yml
- Go to config folder using the command cd config.
- Open alertconfig.yml (e.g., vi /opt/alert/config/alertconfig.yml)
ElasticSearch URL configuration
Add Elasticsearch URL with the port (even if the port is 80) in the alertconfig.yml file in the following format
Proxy server basic authentication configuration
If you are using Nginx or SearchGuard, follow the steps below.
If Nginx is configured as a reverse proxy for Elasticsearch, configure Nginx username and password for Elasticsearch as shown:
- Note: If you are using Shield then refer to Step-by-Step Configuration Guide for Shield.
- Save changes to alertsconfig.yml
Step 7: Start Alerts
You can start Skedler-Alerts as a service or manually.
- To start Skedler-Alerts as a service, execute
sudo service alert start
- To start Skedler-Alerts manually
Change directory to $alert_home (e.g., /opt/alert) and execute
Step 8: Access Alerts
Skedler-Alerts can be accessed from the following URL http://<yourServer>:3001. The Email Configuration page is displayed on successful installation.
Step 9: Activate License Online
Skedler-Alerts is available in the following editions:
- 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 firstname.lastname@example.org.
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 10: Configure Email, Time zone and Weebhook
To schedule Skeldler-Alerts timezone 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
- If you want the alerts to be emailed, configure the outgoing mail settings and email id (from which all the alerts 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.
To test the email configuration, please provide the email id in 'Email to' field and send a test mail to verify the configuration.
Add webhook URL in webhook settings in which you can send the alert notification via webhook. Skedler - Alerts provides webhook with 3 types of authentication
Authentication - None
Basic Authentication with base 64 encoded
OAuth 1.0 Authentication
Click Add Webhook to add the Webhook URL as shown below,
Authentication - None
Select type as None and fill Alias , Webhook URL and click Save button.
To test the Webhook URL, provide the parameters with value and click Test URL button. Will send success response if configured properly.
Oauth1.0 AuthenticationSelect type as OAuth1.0 and fill the required fields client id, client secret key, user token key, user secret key, request token URL, access token URL and click Save button to add the webhook URL with OAuth1.0 Authentication
Basic Authentication with base 64 encoded
Select type as Basic, fill the username and password fields for the basic webhook authentication URL. All the webhook URL with basic authentication are base 64 encoded. Click Save button to add the webhook URL with Basic Authentication.
You are now ready to start scheduling alerts. Refer to Step-by-Step User Guide for Skedler-Alerts to create alerts.