Metadata-Version: 1.1
Name: alignak_notifications
Version: 1.0.1
Summary: Alignak notifications script pack
Home-page: https://github.com/Alignak-monitoring-contrib/alignak-checks-wmi
Author: Frédéric MOHIER
Author-email: frederic.mohier@alignak.net
License: GNU Affero General Public License, version 3
Description: Alignak package for notifications
        =================================
        
        *Alignak package for notifications (simple mail, HTML mail, XMPP)*
        
        .. image:: https://badge.fury.io/py/alignak_notifications.svg
            :target: https://badge.fury.io/py/alignak_notifications
            :alt: Most recent PyPi version
        
        .. image:: https://img.shields.io/badge/IRC-%23alignak-1e72ff.svg?style=flat
            :target: http://webchat.freenode.net/?channels=%23alignak
            :alt: Join the chat #alignak on freenode.net
        
        .. image:: https://img.shields.io/badge/License-AGPL%20v3-blue.svg
            :target: http://www.gnu.org/licenses/agpl-3.0
            :alt: License AGPL v3
        
        Installation
        ------------
        
        The installation of this package will copy some configuration files in the Alignak default configuration directory (eg. */usr/local/etc/alignak*). The copied files are located in the default sub-directory used for the packs (eg. *arbiter/packs*).
        
        Some JSON files
        
        From PyPI
        ~~~~~~~~~
        To install the package from PyPI:
        ::
        
           sudo pip install alignak-notifications
        
        
        From source files
        ~~~~~~~~~~~~~~~~~
        To install the package from the source files:
        ::
        
           git clone https://github.com/Alignak-monitoring-contrib/alignak-notifications
           cd alignak-checks-notifications
           sudo pip install .
        
        **Note:** *using `sudo python setup.py install` will not correctly manage the package configuration files! The recommended way is really to use `pip`;)*
        
        
        Documentation
        -------------
        
        This pack embeds several scripts that can be used to send notifications from Alignak:
        
        - simple printf sent to sendmail
        - python script to send HTML mail
        - python script to send XMPP notifications
        
        **Important:** The HTML mail script is using an Alignak logo image in the mail composition. The default file for this logo is the *alignak.png* file located in the main directory of the project repository. An alternative logo URL can be specified in the notification command parameters.
        
        
        
        Configuration
        ~~~~~~~~~~~~~
        
        Edit the */usr/local/etc/alignak/arbiter/packs/resource.d/notifications.cfg* file and configure
        the SMTP server address, port, user name and password.
        ::
        
            #-- SMTP server configuration
            $SMTP_SERVER$=your_smtp_server_address
            $SMTP_PORT$=25
            $SMTP_LOGIN$=your_smtp_login
            $SMTP_PASSWORD$=your_smtp_password
        
        
        **Note:** The python scripts assume that you have a direct `python` runnable ... if you need to use `python2.7` or something else to run python, you should::
        
            cd /usr/local/bin
            ln -s python2.7 python
        
        
        
        Bugs, issues and contributing
        -----------------------------
        
        Contributions to this project are welcome and encouraged ... `issues in the project repository <https://github.com/alignak-monitoring-contrib/alignak-notifications/issues>`_ are the common way to raise an information.
        
Keywords: a,l,i,g,n,a,k, ,m,o,n,i,t,o,r,i,n,g, ,p,a,c,k, ,c,h,e,c,k,s, ,n,o,t,i,f,i,c,a,t,i,o,n,s
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Topic :: System :: Monitoring
Classifier: Topic :: System :: Systems Administration
