diff --git a/README.md b/README.md index 59af733..e14c7ca 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,22 @@ # znc-xmpp-notify -ZNC module to notify of pings over XMPP. \ No newline at end of file +ZNC module to notify of pings over XMPP. + +## Dependencies + +- ZNC modpython +- sendxmpp + +## Setup +### Set up sendxmpp (administrator) + +1. Create an XMPP account for your ZNC instance's notification bot. +2. Put the JID and password in ~/.sendxmpprc in the format ` ` +3. Make sure modpython is available + +### Set up module (user) + +1. This may not be necessary, but load modpython: `/msg *status loadmod modpython` +2. Load xmppnotify.py, with your preferred JID as the argument: `/msg *status loadmod xmppnotify ` +3. Enjoy. + diff --git a/xmppnotify.py b/xmppnotify.py index 8112f70..0602afb 100644 --- a/xmppnotify.py +++ b/xmppnotify.py @@ -2,7 +2,7 @@ import znc import subprocess class xmppnotify(znc.Module): - description = "XMPP notification module; just a test so far." + description = "XMPP notification module" has_args = True args_help_text = "XMPP address." module_types = [znc.CModInfo.UserModule]