Step 1: Verify Prerequisites for Linux Installation
System Requirements- We recommends 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
- Minimum of 2 CPU cores and 8 GB of RAM is recommended for deploying Skedler-Alerts
- If you are using Skedler-Alerts 3.1 version or earlier, please create alerts with new index (or) deleting the existing alerts index.
- Ubuntu version 12.04 and above
- Debian version 7 and above
Library Dependencies
GLIBCXX libraries
Skedler-Alerts is dependent on libstdc++ library.
Following are the GLIBCXX versions that the code depends on
- 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
To check the versions on your server. Please run the following command
For CentOS
strings /usr/lib64/libstdc++.so.6 | grep GLIBCXX
For Debian/Ubuntu
strings /usr/lib/x86_64-linux-gnu/libstdc++.so.6 | grep GLIBCXX
If the version is not available, update the GCC compiler.
Hostname Configuration
Skedler-Alerts requires hostname of the server in which Skedler-Alerts is installed to be configured in /etc/hosts.
1. Check hostname by giving this command:
$hostname
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,
127.0.0.1 localhost
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 alertconfig.yml then Skedler-Alerts binds to any IP (configured for your system). In this case, your entry in hosts file(/etc/hosts) should be
<ipaddress> <hostname>
4. If the host(IP address of the server) in alertconfig.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
<ipaddress> <hostname>
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,
no_proxy="<ipaddress>,<hostname>"
Elasticsearch version
Skedler-Alerts supports Elasticsearch version from 2.0 to 7.8.0
JAVA_HOME Configuration
Skedler-Alerts requires Java 7, 8 or 9 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>"
NOTE: Skedler user requires user home directory. To check user home directory use the following command,
> echo $HOME
NOTE: Skedler user requires user home directory. To check user home directory use the following command,
> echo $HOME
Step 2: Download
- Download the latest version of Skedler-Alerts from Free Trial page.
Step 3: Extract
- Extract the skedler-alerts.tar.gz 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 into 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
sudo ./install.sh
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, 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 alertconfig.yml
For more configuration options please refer alertconfig.yml configuration.
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
bin/alert
Step 8: Access Alerts
Skedler-Alerts is accessed from the following URL http://<yourServer>:3001. The License Activation page is displayed on successful installation.
Step 9: Activate Alerts
Skedler-Alerts can be activated Online or Offline. Refer the following articles to activate the license
- Step-by-Step Guide for Online License Activation of Skedler-Alerts
- Step-by-Step Guide for Offline License Activation of Skedler-Alerts
Step 10: Configure Settings for Alerts
To configure Skeldler-Alerts settings, refer to How to configure time zone settings, index pattern settings, email settings, Webhook settings for skedler-alerts
Step 11: Schedule Alerts
To create alerts, refer to Step-by-Step User Guide for Creating Skedler-Alerts
References
- Step-by-Step Shield Configuration Guide for Skedler-Alerts
- Step-by-Step Guide for Offline License Activation for Skedler-Alerts
- Step-by-Step Guide to Move Skedler-Alerts from One Machine to Another