Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/erigones/ludolph

Python Jabber Bot
https://github.com/erigones/ludolph

bot jabber jabber-bot monitoring python xmpp zabbix

Last synced: about 1 month ago
JSON representation

Python Jabber Bot

Awesome Lists containing this project

README

        

Ludolph
#######

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

.. image:: https://badge.fury.io/py/ludolph.png
:target: http://badge.fury.io/py/ludolph

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:**

- `ludolph-zabbix `_ (1.5+)
- `dnspython `_ (1.13.0+)
- `sleekxmpp `_ (1.1.11+)
- `bottle `_ (0.12.7+)

Links
-----

- Wiki: https://github.com/erigones/Ludolph/wiki
- Bug Tracker: https://github.com/erigones/Ludolph/issues
- Contribution guide: https://github.com/erigones/Ludolph/wiki/Contribution-guide
- Google+ Community: https://plus.google.com/u/0/communities/112192048027134229675
- Twitter: https://twitter.com/erigones

License
-------

For more information see the `LICENSE `_ file.

Avatars have been designed by `Freepik.com `_.