ViewVC Help
View File | Revision Log | Show Annotations | View Changeset | Root Listing
root/svn/hopm/trunk/README
(Generate patch)

Comparing hopm/trunk/README (file contents):
Revision 9337 by michael, Sun Apr 19 06:25:25 2020 UTC vs.
Revision 9725 by michael, Mon Nov 16 10:14:58 2020 UTC

# Line 3 | Line 3 | Introduction
3  
4   HOPM (Hybrid Open Proxy Monitor) is an open-proxy monitoring bot designed to
5   monitor an individual server (all servers on the network have to run their own
6 < bot if the IRCD does not support `farconnect` user mode) with a local
6 > bot if the IRCD does not support the "far connect" user mode) with a local
7   operator {} block and monitor connections. When a client connects to a server,
8   HOPM will scan the connection for insecure proxies. Insecure proxies are
9   determined by attempting to connect the proxy back to another host (usually the
# Line 21 | Line 21 | Requirements
21   * An IRCD, which presents connection notices in a format, which HOPM recognizes;
22  
23   * A host with full connectivity for all the ports you wish to scan. i.e. is NOT
24 < transparently proxied -- many domestic Internet connections have port 80
24 > transparently proxied -- many domestic internet connections have port 80
25   transparently proxied and this produces completely unpredictable results,
26   sometimes as severe as 100% of clients being K:lined;
27  
# Line 45 | Line 45 | Compatibility
45   * Charybdis 3.4.x
46  
47   HOPM is easily suitable for any other IRCD with little modification (`connregex`
48 < in hopm.conf). However, if an IRCD does not send IP addresses in a connection
48 > in `hopm.conf`). However, if an IRCD does not send IP addresses in a connection
49   notice, HOPM will not work.
50  
51  
52   Command-line options
53   ====================
54  
55 < `-c <name>`     Configuration filename. By default, HOPM reads hopm.conf,
56 <                `-c foo` will cause HOPM to read foo.conf. The primary use for
55 > `-c <name>`     Configuration filename. By default, HOPM reads `hopm.conf`,
56 >                `-c foo` will cause HOPM to read `foo.conf`. The primary use for
57                  this is to run multiple HOPM from one directory.
58  
59 < `-d`            Debug mode. HOPM will not fork and will write logs to stderr.
60 <                Multiple -d increase debug level.
59 > `-d`            Debug mode. HOPM will not fork and will write logs to `stderr`.
60 >                Multiple `-d` increase debug level.
61  
62  
63   Operator channel commands
# Line 65 | Line 65 | Operator channel commands
65  
66   `<bot> check <host> [scanner]`  Manually scans host for insecure proxies and
67                                  outputs all errors. If scanner is not given,
68 <                                HOPM will scan on all scanners.NOTE: this will
69 <                                NOT add a kline if it finds a proxy.
68 >                                HOPM will scan on all scanners. NOTE: this will
69 >                                not add a kline if it finds a proxy.
70  
71   `<bot> stats`                   Outputs scan stats, uptime and connection count.
72  
73   `<bot> fdstat`                  Outputs info about file descriptors in use.
74  
75 < Also, if several HOPM are present in one channel, they will all respond to !all,
75 > Also, if several HOPM are present in one channel, they will all respond to `!all`,
76   for example `!all stats`.
77  
78  
79   Rehashing HOPM
80   ==============
81  
82 < A /quote KILL on HOPM will cause the process to restart, rehashing the
82 > A `/quote KILL` on HOPM will cause the process to restart, rehashing the
83   configuration file and ending all queued scans. The same can be achieved
84 < with "kill -HUP" from the command line.
84 > with `kill -HUP` from the command line.
85  
86  
87   Logging
# Line 92 | Line 92 | which by default can be found at `$HOME/
92   configuration option, `scanlog`, to log all proxy scans initiated, which can be
93   quite useful if you receive an abuse report related to portscanning.
94  
95 < These log files, especially the scan.log, can grow quite large. It is suggested
95 > These log files, especially the `scan.log`, can grow quite large. It is suggested
96   that you arrange for these files to be rotated periodically. You should send a
97   `USR1` signal to HOPM after moving its logfiles -- this will cause HOPM to
98   reopen those files.
# Line 101 | Line 101 | reopen those files.
101   Contact information
102   ===================
103  
104 + * Home page: https://www.ircd-hybrid.org
105   * Bug reports: bugs@ircd-hybrid.org
106   * IRC: #ircd-coders on irc.ircd-hybrid.org
107   * GitHub: https://github.com/ircd-hybrid/hopm

Diff Legend

– Removed lines
+ Added lines
< Changed lines (old)
> Changed lines (new)