Python Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
init.d
ludolph
.gitignore
.travis.yml
LICENSE
MANIFEST.in
README.rst
setup.py

README.rst

Ludolph

Monitoring Jabber Bot with Zabbix support, completely written in Python.

https://badge.fury.io/py/ludolph.png

Features

  • Simple and modular design

  • Alerts from Zabbix

  • Multi-User Chat (XEP-0045)

  • Colorful messages (XEP-0071)

  • Attention (XEP-0224)

  • Avatars (XEP-0084)

  • Roster management and ACL configuration

  • Webhooks and cron jobs

  • Plugins and commands:

    * ludolph.plugins.zabbix
        * ack - acknowledge event with optional note
        * alerts - show a list of current or previous zabbix alerts
        * duty - show a list of users in duty user group
        * groups - show a list of host groups
        * hosts - show a list of hosts
        * outage - show, create or delete maintenance periods
        * zabbix-version - show version of Zabbix API
    
    * ludolph.plugins.base
        * about - details about this project
        * at - list, add, or delete jobs for later execution
        * attention - send XMPP attention to user/room
        * avatar - list available avatars or set an avatar for Ludolph (admin only)
        * broadcast - sent private message to every user in roster (admin only)
        * help - show this help
        * message - send new XMPP message to user/room
        * remind - list, add, or delete reminders
        * roster - list and manage users on Ludolph's roster (admin only)
        * status - set Ludolph's status (admin only)
        * uptime - show Ludolph uptime
        * version - display version of Ludolph or registered plugin
    
    * ludolph.plugins.muc
        * invite - invite user or yourself to multi-user chat room (room admin only)
        * kick - kick user from multi-user chat room (room admin only)
        * motd - show, set or remove message of the day
        * topic - set room subject (room admin only)
    
    * ludolph.plugins.commands
        * os-uptime - display system uptime
    

Installation

  • Install the latest released version using pip:

    pip install ludolph
    
  • Or install the latest development version:

    pip install https://github.com/erigones/ludolph/zipball/master
    
  • Make sure all dependencies (listed below) are installed (done automatically when installing via pip)

  • Create and edit the configuration file:

    cp /usr/lib/python2.7/site-packages/ludolph/ludolph.cfg.example /etc/ludolph.cfg
    
  • The ludolph command should be installed somewhere in your PATH.

  • Init scripts for Debian and RHEL based distributions are also available: https://github.com/erigones/Ludolph/tree/master/init.d

See the complete install guide and Zabbix integration guide for more info.

Dependencies:

Links

License

For more information see the LICENSE file.

Avatars have been designed by Freepik.com.