Step1: Verify Pre-requisites
System Requirements
- 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
- Minimum of 2 CPU cores and 8 GB of RAM is recommended for deploying Skedler Alerts
Library Dependencies
libnss3 library
- Debian/Ubuntu – sudo apt-get install libnss3
Font config libraries
- Debian/Ubuntu – sudo apt-get install libfontconfig
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 the localhost you can't access it from outside.
3. However. If the bind-address is 0.0.0.0, that means skedler alerts binds to any IP (configured for your system). In this case, your entry in the host's 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 5.x to 7.11.x
Step 2: Download
- Download the latest version of Skedler Alerts from Download page.
Step 3: Install Skedler Alerts
Install Skedler Alerts using the below command. Run as a sudo user.
sudo dpkg -i skedler-alerts.deb
Note: Remove Skedler Alerts package using the following command, sudo dpkg -r skedler-alerts
Step 4: Directory Layout
The Debian package places config files, script files, and the logs directory in the appropriate locations for a Debian-based system:
Type | Description | Default Location |
---|---|---|
home | Skedler Alerts home directory or $alert_home | /usr/share/skedler-alerts |
bin | Binary scripts to start Skedler Alerts server | /usr/share/skedler-alerts/bin |
conf | Configuration file alertconfig.yml | /etc/skedler-alerts |
logs | Log files location. | /var/log/skedler-alerts |
Step 5: Configure alertconfig.yml
Configure Skedler configurations like port, Elasticsearch URL and alert_index in /etc/skedler-alerts/alertconfig.yml
To edit the configuration file sudo nano /etc/skedler-alerts/alertconfig.yml
Refer alertconfig.yml configuration
Step 6: Start Skedler Alerts
- To automatically start Skedler Alerts when the system boots up, run the following commands
sudo systemctl daemon-reload
- To start Skedler Alerts, execute the command as shown below,
sudo systemctl start skedler-alerts
- To stop Skedler Alerts, execute the command as shown below,
sudo systemctl stop skedler-alerts
Step 7: Access Skedler Alerts
Once launched, Skedler Alerts can be accessed from the following URL, http://<yourServer>:3001
Step 8: Configure Skedler Alerts Settings
To configure Skeldler Alerts settings, refer to How to configure time zone settings, index pattern settings, email settings, Webhook settings for skedler alerts
You are now ready to start scheduling Alerts.
To create alerts, refer to Step-by-Step User Guide for Creating Skedler Alerts
Step 9: License Upgrade
Activation is required for purchased product license key. In the Community Edition, license activation will be skipped. If you purchase Skedler Alerts license, you will receive a license key by email.
Refer to Upgrade License
Reference
- 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
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article