Move "ClientHost" and "ClientUserNick" to end of [Global] section
[ngircd-alex.git] / doc / Bopm.txt
1
2                      ngIRCd - Next Generation IRC Server
3
4                         (c)2001-2010 Alexander Barton,
5                     alex@barton.de, http://www.barton.de/
6
7                ngIRCd is free software and published under the
8                    terms of the GNU General Public License.
9
10                                 -- BOPM.txt --
11
12
13 I. Introduction
14 ~~~~~~~~~~~~~~~~
15
16 Citing <http://wiki.blitzed.org/BOPM>: "BOPM is an open source open proxy
17 monitor, designed for use with hybrid-based ircds, although it can be used
18 with slight modification on any server which has the ability to show connects
19 to opers and that supports KLINEs."
20
21 And starting with Release 17, ngIRCd supports all required log messages that
22 BOPM requires to be useful.
23
24 II. Installation
25 ~~~~~~~~~~~~~~~~~
26
27 Install BOPM as usual, please see the BOPM documentation for details.
28 Afterwards adjust the following configuration parameters that are important
29 for ngIRCd:
30
31 a) BOPM "IRC" section:
32
33   1) Set "server" and "port" accordingly,
34
35   2) adjust the "oper" line to match an [Operator] block in ngircd.conf,
36
37   3) change "mode" to "+ci" or "+c".
38
39   4) Set "connregex" to the following string, everything in one line(!):
40      "\\*\\*\\* Notice -- Client connecting: ([^ ]+) \\(([^@]+)@([^\\)]+)\\) \\[([0-9\\.]+)\\].*";
41      and comment all the other "connregex" examples (prepend a "#" character).
42
43   5) Set "kline" to "KILL %n :Open proxy found on your host!"; for example,
44      and comment all the other "kline" examples.
45
46 b) BOPM "scanner" section:
47
48   Make sure you configure a valid "target_ip" and "target_port" for the
49   configured scanners to test. And please note that you CAN'T USE the port
50   of ngIRCd, because ngIRCd doesn't send any banner message by default!
51
52   So you need a service what sends a banner, so for example POP3, SMTP,
53   IMAP, or SSH daemons should work ...