X-Git-Url: https://jfr.im/git/solanum.git/blobdiff_plain/0fa09b8024e761c56994ad17c1f41a91c77df5c0..34b88b65713bdc5b4c02aee31fcf1035a005735b:/doc/reference.conf diff --git a/doc/reference.conf b/doc/reference.conf old mode 100755 new mode 100644 index 31817ef3..5d37ed5e --- a/doc/reference.conf +++ b/doc/reference.conf @@ -6,7 +6,6 @@ * * Written by ejb, wcampbel, db, leeh and others * - * $Id: reference.conf 3582 2007-11-17 21:55:48Z jilles $ */ /* IMPORTANT NOTES: @@ -29,80 +28,90 @@ * * Times/durations are written as: * 12 hours 30 minutes 1 second - * + * * Valid units of time: * month, week, day, hour, minute, second * * Valid units of size: * megabyte/mbyte/mb, kilobyte/kbyte/kb, byte * - * Sizes and times may be singular or plural. - */ + * Sizes and times may be singular or plural. + */ /* Extensions: * * Charybdis contains several extensions that are not enabled by default. * To use them, uncomment the lines below. * - * Channel mode +-A (admin only) -- chm_adminonly.la - * Channel mode +-O (oper only) -- chm_operonly.la - * Channel mode +-S (ssl only) -- chm_sslonly.la - * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat.la - * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat.la - * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat.la - * Restrict channel creation to logged in users -- createauthonly.la - * Account bans (+b $a[:mask]) -- extb_account.la - * Banned from another channel (+b $j:mask) -- extb_canjoin.la - * Other-channel bans (+b $c:mask) -- extb_channel.la - * Combination extbans -- extb_combi.la - * Extended ban (+b $x:mask) -- extb_extgecos.la - * Hostmask bans (for combination extbans) -- extb_hostmask.la - * Oper bans (+b $o) -- extb_oper.la - * Realname (gecos) bans (+b $r:mask) -- extb_realname.la - * Server bans (+b $s:mask) -- extb_server.la - * SSL bans (+b $z) -- extb_ssl.la - * HURT system -- hurt.la - * New host mangling (umode +x) -- ip_cloaking_4.0.la - * Old host mangling (umode +h) -- ip_cloaking.la - * Find channel forwards -- m_findforwards.la - * /identify support -- m_identify.la - * Opers cannot be invisible (umode +i) -- no_oper_invis.la - * Far connection notices (snomask +F) -- sno_farconnect.la - * Remote k/d/x line active notices -- sno_globalkline.la - * Remote oper up notices -- sno_globaloper.la - * /whois notifications (snomask +W) -- sno_whois.la - * Oper-override (modehacking only) -- override.la - * Stop services kills -- no_kill_services.la + * Channel mode +-A (admin only) -- chm_adminonly + * Channel mode +-O (oper only) -- chm_operonly + * Channel mode +-S (ssl only) -- chm_sslonly + * Emulates channel mode +-O (oper only) (+-iI $o) -- chm_operonly_compat + * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat + * Emulates channel mode +-S (ssl only) (+-b $~z) -- chm_sslonly_compat + * Channel mode +-M (disallow KICK on IRC ops) -- chm_operpeace + * Restrict channel creation to logged in users -- createauthonly + * Account bans (+b $a[:mask]) -- extb_account + * Banned from another channel (+b $j:mask) -- extb_canjoin + * Other-channel bans (+b $c:mask) -- extb_channel + * Combination extbans -- extb_combi + * Extended ban (+b $x:mask) -- extb_extgecos + * Hostmask bans (for combination extbans) -- extb_hostmask + * Oper bans (+b $o) -- extb_oper + * Realname (gecos) bans (+b $r:mask) -- extb_realname + * Server bans (+b $s:mask) -- extb_server + * SSL bans (+b $z) -- extb_ssl + * User mode bans (+b $u:modes) -- extb_usermode + * Helpops system (umode +H) -- helpops + * HURT system -- hurt + * New host mangling (umode +x) -- ip_cloaking_4.0 + * Old host mangling (umode +h) -- ip_cloaking + * Dynamically extend channel limits -- m_extendchans + * Find channel forwards -- m_findforwards + * /identify support -- m_identify + * Opers cannot be invisible (umode +i) -- no_oper_invis + * Far connection notices (snomask +F) -- sno_farconnect + * Remote k/d/x line active notices -- sno_globalkline + * Remote oper up notices -- sno_globaloper + * Global nick-change notices -- sno_globalnickchange + * /whois notifications (snomask +W) -- sno_whois + * Oper-override (modehacking only) -- override + * Stop services kills -- no_kill_services */ -#loadmodule "extensions/chm_adminonly.la"; -#loadmodule "extensions/chm_operonly.la"; -#loadmodule "extensions/chm_sslonly.la"; -#loadmodule "extensions/chm_operonly_compat.la"; -#loadmodule "extensions/chm_quietunreg_compat.la"; -#loadmodule "extensions/chm_sslonly_compat.la"; -#loadmodule "extensions/createauthonly.la"; -#loadmodule "extensions/extb_account.la"; -#loadmodule "extensions/extb_canjoin.la"; -#loadmodule "extensions/extb_channel.la"; -#loadmodule "extensions/extb_combi.la"; -#loadmodule "extensions/extb_extgecos.la"; -#loadmodule "extensions/extb_hostmask.la"; -#loadmodule "extensions/extb_oper.la"; -#loadmodule "extensions/extb_realname.la"; -#loadmodule "extensions/extb_server.la"; -#loadmodule "extensions/extb_ssl.la"; -#loadmodule "extensions/hurt.la"; -#loadmodule "extensions/ip_cloaking_4.0.la"; -#loadmodule "extensions/ip_cloaking.la"; -#loadmodule "extensions/m_findforwards.la"; -#loadmodule "extensions/m_identify.la"; -#loadmodule "extensions/no_oper_invis.la"; -#loadmodule "extensions/sno_farconnect.la"; -#loadmodule "extensions/sno_globalkline.la"; -#loadmodule "extensions/sno_globaloper.la"; -#loadmodule "extensions/sno_whois.la"; -#loadmodule "extensions/override.la"; -#loadmodule "extensions/no_kill_services.la"; +#loadmodule "extensions/chm_adminonly"; +#loadmodule "extensions/chm_operonly"; +#loadmodule "extensions/chm_sslonly"; +#loadmodule "extensions/chm_operonly_compat"; +#loadmodule "extensions/chm_quietunreg_compat"; +#loadmodule "extensions/chm_sslonly_compat"; +#loadmodule "extensions/chm_operpeace"; +#loadmodule "extensions/createauthonly"; +#loadmodule "extensions/extb_account"; +#loadmodule "extensions/extb_canjoin"; +#loadmodule "extensions/extb_channel"; +#loadmodule "extensions/extb_combi"; +#loadmodule "extensions/extb_extgecos"; +#loadmodule "extensions/extb_hostmask"; +#loadmodule "extensions/extb_oper"; +#loadmodule "extensions/extb_realname"; +#loadmodule "extensions/extb_server"; +#loadmodule "extensions/extb_ssl"; +#loadmodule "extensions/extb_usermode"; +#loadmodule "extensions/helpops"; +#loadmodule "extensions/hurt"; +#loadmodule "extensions/ip_cloaking_4.0"; +#loadmodule "extensions/ip_cloaking"; +#loadmodule "extensions/m_extendchans"; +#loadmodule "extensions/m_findforwards"; +#loadmodule "extensions/m_identify"; +#loadmodule "extensions/no_oper_invis"; +#loadmodule "extensions/sno_farconnect"; +#loadmodule "extensions/sno_globalkline"; +#loadmodule "extensions/sno_globalnickchange"; +#loadmodule "extensions/sno_globaloper"; +#loadmodule "extensions/sno_whois"; +#loadmodule "extensions/override"; +#loadmodule "extensions/no_kill_services"; /* serverinfo {}: Contains information about the server. (OLD M:) */ serverinfo { @@ -127,11 +136,6 @@ serverinfo { */ network_name = "MyNet"; - /* hub: allow this server to act as a hub and have multiple servers - * connected to it. - */ - hub = no; - /* vhost: the IP to bind to when we connect outward to ipv4 servers. * This should be an ipv4 IP only. */ @@ -141,7 +145,7 @@ serverinfo { * This should be an ipv6 IP only. */ #vhost6 = "2001:db7:2::6"; - + /* ssl_private_key: our ssl private key */ ssl_private_key = "etc/ssl.key"; @@ -243,7 +247,7 @@ class "users" { */ cidr_ipv6_bitlen = 64; - /* number_per_cidr: Number of connections to allow from a subnet of the + /* number_per_cidr: Number of connections to allow from a subnet of the * size given in cidr_ipv4_bitlen/cidr_ipv6_bitlen. * 4 seems to be a good default to me. */ @@ -305,19 +309,19 @@ listen { /* port: the specific port to listen on. if no host is specified * before, it will listen on all available IPs. * - * sslport: the specific port to listen ssl connections on. if no + * sslport: the specific port to listen ssl connections on. if no * host is specified before, it will listen on all available IPs. * * ports are seperated via a comma, a range may be specified using ".." */ - + /* port: listen on all available IPs, ports 5000 and 6665 to 6669 */ port = 5000, 6665 .. 6669; - + /* sslport: listen for ssl connections on all available IPs, port 9999 */ sslport = 9999; - /* host: set a specific IP/host the ports after the line will listen + /* host: set a specific IP/host the ports after the line will listen * on. This may be ipv4 or ipv6. */ host = "192.0.2.6"; @@ -351,7 +355,7 @@ auth { * flags = ...; below if it is. */ password = "letmein"; - + /* spoof: fake the users user@host to be be this. You may either * specify a host or a user@host to spoof to. This is free-form, * just do everyone a favour and dont abuse it. (OLD I: = flag) @@ -359,12 +363,14 @@ auth { spoof = "I.still.hate.packets"; /* Possible flags in auth: - * + * * encrypted | password is encrypted with mkpasswd * spoof_notice | give a notice when spoofing hosts * exceed_limit (old > flag) | allow user to exceed class user limits - * kline_exempt (old ^ flag) | exempt this user from k/g/xlines&dnsbls + * kline_exempt (old ^ flag) | exempt this user from k/g/xlines, + * | dnsbls, and proxies * dnsbl_exempt | exempt this user from dnsbls + * proxy_exempt | exempt this user from proxies * spambot_exempt | exempt this user from spambot checks * shide_exempt | exempt this user from serverhiding * jupe_exempt | exempt this user from generating @@ -376,9 +382,10 @@ auth { * need_ident (old + flag) | require ident for user in this class * need_ssl | require SSL/TLS for user in this class * need_sasl | require SASL id for user in this class + * extend_chans | allow this user to join more channels than normal */ flags = kline_exempt, exceed_limit; - + /* class: the class the user is placed in */ class = "opers"; }; @@ -390,7 +397,7 @@ auth { */ redirserv = "irc.example.net"; redirport = 6667; - + user = "*.example.com"; /* class: a class is required even though it is not used */ @@ -431,6 +438,7 @@ privset "local_op" { * oper:hidden: hides the oper from /stats p * oper:remoteban: allows remote kline etc * oper:mass_notice: allows sending wallops and mass notices + * oper:grant: allows using the GRANT command */ privs = oper:local_kill, oper:operwall; }; @@ -449,7 +457,7 @@ privset "global_op" { privset "admin" { extends = "global_op"; - privs = oper:admin, oper:die, oper:rehash, oper:spy; + privs = oper:admin, oper:die, oper:rehash, oper:spy, oper:grant; }; /* operator {}: defines ircd operators. (OLD O:) */ @@ -464,13 +472,13 @@ operator "god" { user = "*@127.0.0.1"; /* password: the password required to oper. Unless ~encrypted is - * contained in flags = ...; this will need to be encrypted using + * contained in flags = ...; this will need to be encrypted using * mkpasswd, MD5 is supported */ password = "etcnjl8juSU1E"; /* rsa key: the public key for this oper when using Challenge. - * A password should not be defined when this is used, see + * A password should not be defined when this is used, see * doc/challenge.txt for more information. */ #rsa_public_key_file = "/usr/local/ircd/etc/oper.pub"; @@ -667,6 +675,9 @@ shared { * dline - allow setting perm/temp dlines * tdline - allow setting temp dlines * undline - allow removing dlines + * grant - allow granting operator status + * die - allow remote DIE/RESTART + * module - allow remote module commands * none - disallow everything */ @@ -733,6 +744,9 @@ channel { /* max chans: The maximum number of channels a user can join/be on. */ max_chans_per_user = 15; + /* max chans (large): The extended maximum number of channels a user can join. */ + max_chans_per_user_large = 60; + /* max bans: maximum number of +b/e/I/q modes in a channel */ max_bans = 100; @@ -753,7 +767,7 @@ channel { default_split_user_count = 0; /* split servers: when the amount of servers that have acknowledged - * theyve finished bursting is lower than this, consider ourselves + * theyve finished bursting is lower than this, consider ourselves * split. this must be set for automatic splitmode */ default_split_server_count = 0; @@ -808,6 +822,9 @@ channel { * such as LIST >0. */ displayed_usercount = 3; + + /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */ + strip_topic_colors = no; }; @@ -839,8 +856,7 @@ serverhide { * You can have multiple combinations of host and rejection reasons. * They are used in pairs of one host/rejection reason. * - * These settings should be adequate for most networks, and are (presently) - * required for use on StaticBox. + * These settings should be adequate for most networks. * * Word to the wise: Do not use blacklists like SPEWS for blocking IRC * connections. @@ -865,7 +881,7 @@ serverhide { * to match the final octet (e.g. 127.0.0.1) or "127.x.y.z" to explicitly match * an A record. The blacklist is only applied if it matches anything in the * list. You may freely mix full IP's and final octets. - * + * * Consult your blacklist provider for the meaning of these parameters; they * are usually used to denote different ban types. */ @@ -881,6 +897,67 @@ blacklist { # reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for some reason. In order to protect ${network-name} from abuse, we are not allowing connections listed in ${dnsbl-host} to connect"; }; +/* These are the OPM settings. + * This is similar to the functionality provided by BOPM. It will scan incoming + * connections for open proxies by connecting to clients and attempting several + * different open proxy handshakes. If they connect back to us (via a dedicated + * listening port), and send back the data we send them, they are considered + * an open proxy. For politeness reasons (users may be confused by the incoming + * connection attempts if they are logging incoming connections), the user is + * notified upon connect if they are being scanned. + * + * WARNING: + * These settings are considered experimental, and as of this writing, the + * Charybdis scanner is not as comprehensive as the one available in HOPM. Only + * basic SOCKS4 and SOCKS5 scanning is performed on a few well-known ports. You + * may disable the open proxy scanning feature by deleting this block if you are + * uncomfortable with this. + */ +opm { + /* IPv4 address to listen on. This must be a publicly facing IP address + * to be effective. + * If omitted, it defaults to serverinfo::vhost. + */ + #listen_ipv4 = "127.0.0.1"; + + /* IPv4 port to listen on. + * This should not be the same as any existing listeners. + */ + #port_ipv4 = 32000; + + /* IPv6 address to listen on. This must be a publicly facing IP address + * to be effective. + * If omitted, it defaults to serverinfo::vhost6. + */ + #listen_ipv6 = "0::1"; + + /* IPv6 port to listen on. + * This should not be the same as any existing listeners. + */ + #port_ipv6 = 32000; + + /* You can also set a port directive which will set both the IPv4 and + * IPv6 ports at once. + */ + port = 32000; + + /* These are the ports to scan for SOCKS4 proxies on. They may overlap + * with other scan types. Sensible defaults are given below. + */ + socks4_ports = 80, 443, 1080, 8000, 8080, 10800; + + /* These are the ports to scan for SOCKS5 proxies on. They may overlap + * with other scan types. Sensible defaults are given below. + */ + socks5_ports = 80, 443, 1080, 8000, 8080, 10800; + + /* These are the ports to scan for HTTP connect proxies on (plaintext). + * They may overlap with other scan types. Sensible defaults are given + * below. + */ + httpconnect_ports = 80, 8080, 8000; +}; + /* * Alias blocks allow you to define custom commands. (Old m_sshortcut.c) * They send PRIVMSG to the given target. A real command takes @@ -997,7 +1074,7 @@ general { */ default_floodcount = 10; - /* failed oper notice: send a notice to all opers on the server when + /* failed oper notice: send a notice to all opers on the server when * someone tries to OPER and uses the wrong password, host or ident. */ failed_oper_notice = yes; @@ -1069,19 +1146,19 @@ general { * displayed unconditionally. */ global_snotices = yes; - - /* dline reason: show the user the dline reason when they connect + + /* dline reason: show the user the dline reason when they connect * and are dlined. */ dline_with_reason = yes; - + /* kline delay: delay the checking of klines until a specified time. * Useful if large kline lists are applied often to prevent the * server eating CPU. */ kline_delay = 0 seconds; - /* kline reason: show the user the reason why they are k/dlined + /* kline reason: show the user the reason why they are k/dlined * on exit. may give away who set k/dline when set via tcm. */ kline_with_reason = yes; @@ -1103,7 +1180,7 @@ general { non_redundant_klines = yes; /* warn no nline: warn opers about servers that try to connect but - * we dont have a connect {} block for. Twits with misconfigured + * we dont have a connect {} block for. Twits with misconfigured * servers can get really annoying with this enabled. */ warn_no_nline = yes; @@ -1133,7 +1210,7 @@ general { stats_o_oper_only=yes; /* stats P oper only: make stats P (ports) oper only - * NOTE: users doing stats P will never be given the ips that the + * NOTE: users doing stats P will never be given the ips that the * server listens on, simply the ports. */ stats_P_oper_only=no; @@ -1207,8 +1284,8 @@ general { /* REMOVE ME. The following line checks you've been reading. */ havent_read_conf = yes; - - /* max targets: the maximum amount of targets in a single + + /* max targets: the maximum amount of targets in a single * PRIVMSG/NOTICE. set to 999 NOT 0 for unlimited. */ max_targets = 4; @@ -1222,7 +1299,7 @@ general { * * +g - callerid - Server Side Ignore * +D - deaf - Don't see channel messages - * +i - invisible - Not shown in NAMES or WHO unless you share a + * +i - invisible - Not shown in NAMES or WHO unless you share a * a channel * +l - locops - See LOCOPS messages * +Q - noforward - Unaffected by channel forwarding @@ -1231,7 +1308,7 @@ general { * +w - wallop - See oper and server generated WALLOPS * +z - operwall - See operwalls */ - + /* oper only umodes: usermodes only opers may set */ oper_only_umodes = operwall, locops, servnotice; @@ -1243,7 +1320,7 @@ general { oper_snomask = "+s"; /* compression level: level of compression for compressed links between - * servers. + * servers. * * values are between: 1 (least compression, fastest) * and: 9 (most compression, slowest). @@ -1318,15 +1395,18 @@ general { * prior to charybdis 3.5 MUST use sha1 for certfp_method. */ certfp_method = sha1; + + /* hide_opers_in_whois: if set to YES, then oper status will be hidden in /WHOIS output. */ + hide_opers_in_whois = no; }; modules { - /* module path: paths to search for modules specified below and + /* module path: paths to search for modules specified below and * in /modload. */ path = "/usr/local/ircd/modules"; path = "/usr/local/ircd/modules/autoload"; /* module: the name of a module to load on startup/rehash */ - #module = "some_module.la"; + #module = "some_module"; };