Documentation: Comment-out the OPM block and its options by default

The feature is not yet stable and is causing several issues.
This commit is contained in:
Aaron Jones 2016-12-28 23:41:32 +00:00
parent 41390bfe5f
commit 28f877462d
No known key found for this signature in database
GPG key ID: EC6F86EE9CD840B5
2 changed files with 18 additions and 20 deletions

View file

@ -440,10 +440,9 @@ blacklist {
* WARNING: * WARNING:
* These settings are considered experimental. Only the most common proxy types * These settings are considered experimental. Only the most common proxy types
* are checked for (Charybdis is immune from POST and GET proxies). If you are * are checked for (Charybdis is immune from POST and GET proxies). If you are
* not comfortable with experimental code, remove or comment out the *entire* * not comfortable with experimental code, do not use this feature.
* block below to disable the proxy scanner.
*/ */
opm { #opm {
/* IPv4 address to listen on. This must be a publicly facing IP address /* IPv4 address to listen on. This must be a publicly facing IP address
* to be effective. * to be effective.
* If omitted, it defaults to serverinfo::vhost. * If omitted, it defaults to serverinfo::vhost.
@ -469,37 +468,37 @@ opm {
/* You can also set the listen_port directive which will set both the /* You can also set the listen_port directive which will set both the
* IPv4 and IPv6 ports at once. * IPv4 and IPv6 ports at once.
*/ */
listen_port = 32000; #listen_port = 32000;
/* This sets the timeout in seconds before ending open proxy scans. /* This sets the timeout in seconds before ending open proxy scans.
* Values less than 1 or greater than 60 are ignored. * Values less than 1 or greater than 60 are ignored.
* It is advisable to keep it as short as feasible, so clients do not * It is advisable to keep it as short as feasible, so clients do not
* get held up by excessively long scan times. * get held up by excessively long scan times.
*/ */
timeout = 5; #timeout = 5;
/* These are the ports to scan for SOCKS4 proxies on. They may overlap /* These are the ports to scan for SOCKS4 proxies on. They may overlap
* with other scan types. Sensible defaults are given below. * with other scan types. Sensible defaults are given below.
*/ */
socks4_ports = 1080, 10800, 443, 80, 8080, 8000; #socks4_ports = 1080, 10800, 443, 80, 8080, 8000;
/* These are the ports to scan for SOCKS5 proxies on. They may overlap /* These are the ports to scan for SOCKS5 proxies on. They may overlap
* with other scan types. Sensible defaults are given below. * with other scan types. Sensible defaults are given below.
*/ */
socks5_ports = 1080, 10800, 443, 80, 8080, 8000; #socks5_ports = 1080, 10800, 443, 80, 8080, 8000;
/* These are the ports to scan for HTTP connect proxies on (plaintext). /* These are the ports to scan for HTTP connect proxies on (plaintext).
* They may overlap with other scan types. Sensible defaults are given * They may overlap with other scan types. Sensible defaults are given
* below. * below.
*/ */
httpconnect_ports = 80, 8080, 8000; #httpconnect_ports = 80, 8080, 8000;
/* These are the ports to scan for HTTPS CONNECT proxies on (SSL). /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
* They may overlap with other scan types. Sensible defaults are given * They may overlap with other scan types. Sensible defaults are given
* below. * below.
*/ */
httpsconnect_ports = 443, 4443; #httpsconnect_ports = 443, 4443;
}; #};
alias "NickServ" { alias "NickServ" {
target = "NickServ"; target = "NickServ";

View file

@ -919,10 +919,9 @@ blacklist {
* WARNING: * WARNING:
* These settings are considered experimental. Only the most common proxy types * These settings are considered experimental. Only the most common proxy types
* are checked for (Charybdis is immune from POST and GET proxies). If you are * are checked for (Charybdis is immune from POST and GET proxies). If you are
* not comfortable with experimental code, remove or comment out the *entire* * not comfortable with experimental code, do not use this feature.
* block below to disable the proxy scanner.
*/ */
opm { #opm {
/* IPv4 address to listen on. This must be a publicly facing IP address /* IPv4 address to listen on. This must be a publicly facing IP address
* to be effective. * to be effective.
* If omitted, it defaults to serverinfo::vhost. * If omitted, it defaults to serverinfo::vhost.
@ -948,37 +947,37 @@ opm {
/* You can also set the listen_port directive which will set both the /* You can also set the listen_port directive which will set both the
* IPv4 and IPv6 ports at once. * IPv4 and IPv6 ports at once.
*/ */
listen_port = 32000; #listen_port = 32000;
/* This sets the timeout in seconds before ending open proxy scans. /* This sets the timeout in seconds before ending open proxy scans.
* Values less than 1 or greater than 60 are ignored. * Values less than 1 or greater than 60 are ignored.
* It is advisable to keep it as short as feasible, so clients do not * It is advisable to keep it as short as feasible, so clients do not
* get held up by excessively long scan times. * get held up by excessively long scan times.
*/ */
timeout = 5; #timeout = 5;
/* These are the ports to scan for SOCKS4 proxies on. They may overlap /* These are the ports to scan for SOCKS4 proxies on. They may overlap
* with other scan types. Sensible defaults are given below. * with other scan types. Sensible defaults are given below.
*/ */
socks4_ports = 80, 443, 1080, 8000, 8080, 10800; #socks4_ports = 80, 443, 1080, 8000, 8080, 10800;
/* These are the ports to scan for SOCKS5 proxies on. They may overlap /* These are the ports to scan for SOCKS5 proxies on. They may overlap
* with other scan types. Sensible defaults are given below. * with other scan types. Sensible defaults are given below.
*/ */
socks5_ports = 80, 443, 1080, 8000, 8080, 10800; #socks5_ports = 80, 443, 1080, 8000, 8080, 10800;
/* These are the ports to scan for HTTP CONNECT proxies on (plaintext). /* These are the ports to scan for HTTP CONNECT proxies on (plaintext).
* They may overlap with other scan types. Sensible defaults are given * They may overlap with other scan types. Sensible defaults are given
* below. * below.
*/ */
httpconnect_ports = 80, 8080, 8000; #httpconnect_ports = 80, 8080, 8000;
/* These are the ports to scan for HTTPS CONNECT proxies on (SSL). /* These are the ports to scan for HTTPS CONNECT proxies on (SSL).
* They may overlap with other scan types. Sensible defaults are given * They may overlap with other scan types. Sensible defaults are given
* below. * below.
*/ */
httpsconnect_ports = 443, 4443; #httpsconnect_ports = 443, 4443;
}; #};
/* /*
* Alias blocks allow you to define custom commands. (Old m_sshortcut.c) * Alias blocks allow you to define custom commands. (Old m_sshortcut.c)