Added a README

diff --git a/README b/README
new file mode 100644 (file)
index 0000000..4a54f57
--- /dev/null
+++ b/README
@@ -0,0 +1,35 @@
+================================================================================
+
+               Siplog -- A Simple SIP Logging Plugin for ulogd
+
+                      (c) 2008 Martin Mares <mj@ucw.cz>
+
+       You can use and distribute this program under the terms of GPLv2.
+
+================================================================================
+
+
+This program sits at a router over which a SIP box (tested with Linksys PAP2)
+sends its packets. Whenever a phone call is attempted, it sends an e-mail to
+a specified address with the status of the call. I use it for reporting of
+lost calls when I am not at home. Besides that, it's a nice example of passive
+network monitoring.
+
+Siplog is a plugin for the ulogd user-space packet logging daemon. You should
+add the following items to /etc/ulogd.conf:
+
+       [global]
+       plugin="/usr/local/lib/ulogd/siplog.so"
+
+       [SIP]
+       file="/var/log/ulog/sip.log"
+       debuglog="/var/log/ulog/sip.debug"
+       mailto="where-to-send-reports@example.net"
+
+Then it remains to configure iptables to pass the SIP packets to ulogd. Add the
+following rules to the FORWARD chain:
+
+       -s $YOUR_SIP_GW -p udp --sport 5060 -j ULOG --ulog-prefix phone-out
+       -d $YOUR_SIP_GW -p udp --dport 5060 -j ULOG --ulog-prefix phone-in
+
+Have fun.