/[svn]/hopm/branches/1.0.x/README
ViewVC logotype

Diff of /hopm/branches/1.0.x/README

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

revision 5146 by michael, Thu Dec 25 19:44:15 2014 UTC revision 5147 by michael, Fri Dec 26 14:33:45 2014 UTC
# Line 2  Introduction Line 2  Introduction
2  ------------  ------------
3    
4  HOPM (Hybrid Open Proxy Monitor) is an open proxy monitoring bot designed for  HOPM (Hybrid Open Proxy Monitor) is an open proxy monitoring bot designed for
5  Hybrid based ircds.  The bot is designed to monitor an individual server (all  Hybrid based ircds. The bot is designed to monitor an individual server (all
6  servers on the network have to run their own bot) with a local operator {}  servers on the network have to run their own bot) with a local operator {}
7  block and monitor connections.  When a client connects to the server, HOPM will  block and monitor connections. When a client connects to the server, HOPM will
8  scan the connection for insecure proxies.  Insecure proxies are determined by  scan the connection for insecure proxies. Insecure proxies are determined by
9  attempting to connect the proxy back to another host (usually the IRC server in  attempting to connect the proxy back to another host (usually the IRC server in
10  question).  question).
11    
12  HOPM is written ground-up in C language, concept derived from wgmon.  It  HOPM is written ground-up in C language, concept derived from wgmon. It
13  improves on wgmon with HTTP support, faster scanning (it can scan clients  improves on wgmon with HTTP support, faster scanning (it can scan clients
14  simultaneously), better layout (scalability), and dnsbl support.  simultaneously), better layout (scalability), and dnsbl support.
15    
# Line 20  Requirements Line 20  Requirements
20  o An IRCd which presents connection notices in a format which HOPM  o An IRCd which presents connection notices in a format which HOPM
21    recognises (see below).    recognises (see below).
22    
23  o A host with full connectivity for all the ports you wish to scan.  i.e. is  o A host with full connectivity for all the ports you wish to scan. i.e. is
24    NOT transparently proxied -- many domestic internet connections have port 80    NOT transparently proxied -- many domestic internet connections have port 80
25    transparently proxied and this produces completely unpredictable results,    transparently proxied and this produces completely unpredictable results,
26    sometimes as severe as 100% of clients being K:lined!    sometimes as severe as 100% of clients being K:lined!
# Line 35  Compatibility Line 35  Compatibility
35    
36  ircd-hybrid 8.2.1  ircd-hybrid 8.2.1
37    
38  HOPM is designed for ircd-hybrid based ircds.  It is easily suitable for any  HOPM is designed for ircd-hybrid based ircds. It is easily suitable for any
39  other ircd with little modification (connregex in hopm.conf). However, if an  other ircd with little modification (connregex in hopm.conf). However, if an
40  ircd does not send IP addresses in a connection notice, HOPM will not be  ircd does not send IP addresses in a connection notice, HOPM will not be
41  effective because the time it takes to resolve a hostname would be a  effective because the time it takes to resolve a hostname would be a
# Line 45  significant factor to HOPM's efficiency. Line 45  significant factor to HOPM's efficiency.
45  Command Line Options  Command Line Options
46  --------------------  --------------------
47    
48  -c <name>       Config name.  By default HOPM reads hopm.conf, "-c foo"  -c <name>       Config name. By default HOPM reads hopm.conf, "-c foo"
49                  will cause HOPM to read foo.conf.  The primary use for                  will cause HOPM to read foo.conf. The primary use for
50                  this is to run multiple HOPMs from one directory.                  this is to run multiple HOPMs from one directory.
51    
52  -d              Debug mode.  HOPM will not fork, and will write logs to stderr.  -d              Debug mode. HOPM will not fork, and will write logs to stderr.
53                  Multiple -d increase debug level.                  Multiple -d increase debug level.
54    
55    
# Line 80  Logging Line 80  Logging
80  -------  -------
81    
82  Once started, HOPM logs all significant events to a file called "hopm.log"  Once started, HOPM logs all significant events to a file called "hopm.log"
83  which by default can be found at $HOME/hopm/var/hopm.log.  There is also a  which by default can be found at $HOME/hopm/var/hopm.log. There is also a
84  config option to log all proxy scans initiated, which can be quite useful if  config option to log all proxy scans initiated, which can be quite useful if
85  you receive an abuse report related to portscanning.  you receive an abuse report related to portscanning.
86    
87  These log files, especially the scan log, can grow quite large.  It is  These log files, especially the scan log, can grow quite large. It is
88  suggested that you arrange for these files to be rotated periodically.  An  suggested that you arrange for these files to be rotated periodically. An
89  example shell script is provided in the contrib/logrotate directory.  If you  example shell script is provided in the contrib/logrotate directory. If you
90  prefer to use the log rotation facilities of your operating system then you  prefer to use the log rotation facilities of your operating system then you
91  should send a USR1 signal to HOPM after moving its logfiles - this will cause  should send a USR1 signal to HOPM after moving its logfiles - this will cause
92  HOPM to reopen those files.  HOPM to reopen those files.

Legend:
Removed from v.5146  
changed lines
  Added in v.5147

svnadmin@ircd-hybrid.org
ViewVC Help
Powered by ViewVC 1.1.28