bopm.conf.sample

   1 ##################################################################################
   2 #                       Blitzed Open Proxy Monitor                               #
   3 #                                                                                #
   4 #                           Configuration File                                   #
   5 #                                                                                #
   6 ##################################################################################
   7
   8
   9
  10 # NICK <nickname> : Defines what nickname BOPM will be using.
  11 #
  12
  13 NICK BopmDebug
  14
  15
  16
  17 # USER <username> : Defines what username BOPM will be using in place of
  18 #                   ident.
  19 #
  20
  21 USER bopm
  22
  23
  24 # REALNAME <realname> : What realname (the bit in /whois after
  25 #                       nick/ident/host) should bopm use?
  26 #
  27
  28 REALNAME Blitzed Open Proxy Monitor
  29
  30
  31 # NICKSERV_IDENT <line> : Line to send to nickserv to identify
  32 #                         Leave commented to not use.
  33
  34 #NICKSERV_IDENT PRIVMSG NICKSERV :IDENTIFY password1234
  35 NICKSERV_IDENT NICKSERV :IDENTIFY password1234
  36
  37
  38
  39 # CHANSERV_INVITE <line> : Line to send to chanserv to request invite to a
  40 #                          channel. %s must exist in the line and is the
  41 #                          channel.  Leave commented to not use.
  42
  43 #CHANSERV_INVITE PRIVMSG CHANSERV :INVITE %s
  44 CHANSERV_INVITE CHANSERV :INVITE %s
  45
  46
  47
  48 # BINDIRC <ip> : IP to bind to for IRC connection
  49 #
  50
  51 #BINDIRC 127.0.0.1
  52
  53
  54
  55
  56 # BINDSCAN <ip> : IP to bind to for scan connections
  57 #
  58
  59 #BINDSCAN 127.0.0.1
  60
  61
  62
  63
  64 # SERVER <servername> : IRC host BOPM will be monitoring connections on.
  65 #                       This is what bopm will connect to, so please make
  66 #                       sure it works.
  67 #
  68
  69 SERVER myserver.blitzed.org
  70
  71
  72 # PASSWORD <password> : If you need a password to connect to your server,
  73 #                       define it here.  Leave commented if not.
  74
  75 #PASSWORD verysecret
  76
  77
  78
  79
  80 # PORT <port> : Port of IRC host BOPM will be monitoring connections on
  81 #               This is the port that BOPM will connect to in order to get on
  82 #               IRC itself, it is nothing to do with what ports it checks on
  83 #               clients, nor do you need to list every port your ircd
  84 #               accepts clients on.  You need only 1 PORT definition.
  85 #
  86
  87 PORT 6667
  88
  89
  90
  91
  92 # CHANNELS <list> : Comma seperated list of channels bot will join/privmsg
  93 #                   information.
  94 #                   There cannot be spaces between channels, only commas.
  95
  96 CHANNELS #bopm,#wg
  97
  98
  99 # KEYS <list> : Comma separated list of keys for channels above.  Again
 100 #               there should not be spaces between these keys, only
 101 #               commas.  Also if a channel above does not need a key, you
 102 #               need to put some text anyway, it will be ignored (this is
 103 #               the same syntax that IRC clients use to join multiple
 104 #               channels).
 105 #               Keep this commented if you don't need any keys.
 106
 107 #KEYS secret
 108
 109
 110
 111 # OPER <user> <pass> : Username and Password of O line BOPM will be using
 112 #
 113
 114 OPER bopm operpss
 115
 116
 117 # OPER_MODES <modes> : Mode string to set on itself as soon as it opers up.
 118 #                      This should include whatever mode enables connect
 119 #                      notices (usually +c), and often a good idea to disable
 120 #                      helper modes so that users don't try to talk to the
 121 #                      bopm
 122
 123 OPER_MODES +c-h
 124
 125
 126
 127
 128 # SCANIP <ip> : IP to command possible open proxy to connect to. This is
 129 #               usually the same IP as the IRC host we're monitoring.  Don't
 130 #               leave this 127.0.0.1
 131
 132 SCANIP 127.0.0.1
 133
 134
 135
 136
 137 # SCANPORT <port> : Port to command possible open proxy to connect to.
 138 #                   This is usually an IRC related port (such as 6667).  THIS
 139 #                   HAS NOTHING TO DO WITH WHAT PORTS ARE SCANNED!  When BOPM
 140 #                   connects to the client, this is the port ON YOUR SERVER
 141 #                   that BOPM tries to make it connect to.  This should
 142 #                   normally be a port that your ircd is listening on.  You
 143 #                   therefore only need one SCANPORT directive.
 144
 145 SCANPORT 6667
 146
 147
 148
 149
 150 # TIMEOUT <seconds> : Number of seconds before a particular scan on a client
 151 #                     will timeout. The higher this is set, the more chance of
 152 #                     slower proxies being caught. However a higher value also means
 153 #                     more demand for file descriptors at any one time.
 154 #                     A default value of 30 is recommended.
 155
 156 TIMEOUT 30
 157
 158
 159
 160
 161 # TARGET_STRING <string> : Target string we test for in the data read by the scanner,
 162 #                          this should be a string within the data that your ircd usually
 163 #                          sends on connect. The default should work on most bahamut
 164 #                          based ircds once you edit it for your server name.
 165 #
 166 #                          Suggestion is to place the FULL notice string with the server
 167 #                          source name as your target string (this won't work for hybrid
 168 #                          servers as they don't send the server source.
 169 #
 170 #                          This would prevent the odd clients running IRC servers on port
 171 #                          8080/8000 from being confused with a proxy.
 172
 173 TARGET_STRING *** Looking up your hostname...
 174
 175
 176
 177 # KLINE_COMMAND <command> : Line used in issuing KLINES. Two %s are required
 178 #                           within the line which will specify the klined
 179 #                           host and the IP address which you may find
 180 #                           useful in a URL.
 181 #
 182 #                           Do not add anymore ':' characters after the initial
 183 #                           : character in the kline (even for a website) as
 184 #                           the IRCD will reject it.
 185 #
 186 #                           You should probably make sure this is a
 187 #                           TEMPORARY KLINE, otherwise people who fix their
 188 #                           proxies will not be able to get back onto your
 189 #                           net.  The example below is correct for DALNet's
 190 #                           Bahamut and by default places a 30 minute
 191 #                           KLINE.
 192 #
 193 #     !!!! IMPORTANT !!!!   If you change the description on the line below
 194 #                           WE WILL NOT SUPPORT YOU. It is very important that
 195 #                           users banned are able to visit the DNSBL and remove
 196 #                           themselves; if not, they will be permanantly banned
 197 #                           from your network (as they will not have the
 198 #                           knowledge to remove themselves from the DNSBL).
 199 #
 200 #                           If you don't like the rather Blitzed-like pages
 201 #                           then you can use this command instead:
 202 #
 203 # KLINE_COMMAND KLINE *@%s :Open Proxy found on your host. Please visit www.blitzed.org/opm/index2.phtml?ip=%s for more information
 204 #
 205 #                           Here's a GLINE example for ircU:
 206 # KLINE_COMMAND GLINE +*@%s 1800 :Open proxy found on your host. Please visit www.blitzed.org/proxy?ip=%s for more information.
 207
 208 KLINE_COMMAND KLINE *@%s :Open Proxy found on your host. Please visit www.blitzed.org/proxy?ip=%s for more information.
 209
 210
 211
 212
 213 # DNSBL_ZONE <name> : Name of the DNS zone that every user will be checked
 214 #                     against.  For example, Blitzed uses opm.blitzed.org (and
 215 #                     you can too, if you like).  If you don't understand what
 216 #                     a DNSBL is, you can try looking at
 217 #                     http://www.blitzed.org/opm.  This zone should NOT have a
 218 #                     dot at the end.  If you leave this variable commented, no
 219 #                     check will be done.
 220
 221 DNSBL_ZONE opm.blitzed.org
 222
 223
 224
 225
 226 # DNSBL_TO <email> : Email address that reports of open proxies should be
 227 #                    sent to.  If this is not set, proxies will not be reported
 228 #                    by email.  You can report to multiple addresses by
 229 #                    separating them with commas.
 230
 231 #DNSBL_TO postmaster@[127.0.0.1]
 232
 233
 234
 235
 236 # DNSBL_FROM <email> : Email address that your bopm will use to communicate
 237 #                      with DNSBL_TO, above.  The Blitzed DNSBL requires
 238 #                      that this email address be received by a real person,
 239 #                      i.e. you.  If this is not set, proxies will not be
 240 #                      reported by email.
 241
 242 #DNSBL_FROM email@example.com
 243
 244
 245
 246
 247 # SENDMAIL <path> : Absolute path to your sendmail binary.  If this is not
 248 #                   set, proxies will not be reported by email.
 249
 250 #SENDMAIL /usr/sbin/sendmail
 251
 252
 253
 254
 255 # HELP_EMAIL <email> : When someone messages bopm with "INFO" it will tell
 256 #                      them to email a certain address for help.  If you are a
 257 #                      Blitzed admin you should be setting this to
 258 #                      "help@lists.blitzed.org"
 259
 260 HELP_EMAIL help@lists.blitzed.org
 261
 262
 263
 264
 265 # AWAY <away message> : If this is set then bopm will use it as an away
 266 #                       message as soon as it connects.
 267
 268 AWAY I'm a bot.  Your messages will be ignored.
 269
 270 # FDLIMIT <limit> : Limit number of open file descriptors for SCAN ONLY (this does
 271 #                   not include file descriptors used for the IRC socket or log files.
 272 #                   Once limit has been reached, any further scans are queued until
 273 #                   there are file descriptors free
 274 #
 275 #                   Keep this limit equal or less than MAXPOLL as defined in options.h
 276
 277 FDLIMIT 512
 278
 279
 280 # EXCLUDE <hostmask> : Exclude hosts matching this pattern from DNSBL
 281 #                      checks and proxy scans.  The hostmask uses familiar
 282 #                      IRC wildcards * and ? and matches against both IP
 283 #                      and hostname.  Use EXCLUDE multiple times to build a
 284 #                      list.  You should not be using EXCLUDE unless you
 285 #                      have very good reason; if BOPM is finding false
 286 #                      positives then we regard that a serious problem and
 287 #                      would like to be told.
 288
 289 #EXCLUDE 192.168.0.*
 290 #EXCLUDE some-isp-??.example.com
 291
 292 # PIDFILE <filepath> : Full path specifying where bopm should record its
 293 #                      process ID.
 294
 295 PIDFILE /path/to/bopm.pid