]> jfr.im git - solanum.git/blobdiff - doc/example.conf
Add option to immediately apply nick RESVs by FNC'ing.
[solanum.git] / doc / example.conf
index 09a51896540a108f89db558864ef1949a5f83f6a..ba010723a753cf0d77bd30a43393724e4f2f3b9f 100755 (executable)
@@ -23,7 +23,6 @@
 #loadmodule "extensions/extb_server.so";
 #loadmodule "extensions/extb_ssl.so";
 #loadmodule "extensions/hurt.so";
-#loadmodule "extensions/ip_cloaking.so";
 #loadmodule "extensions/m_findforwards.so";
 #loadmodule "extensions/m_identify.so";
 #loadmodule "extensions/no_oper_invis.so";
 #loadmodule "extensions/sno_globalkline.so";
 #loadmodule "extensions/sno_globaloper.so";
 #loadmodule "extensions/sno_whois.so";
+#loadmodule "extensions/override.so";
+
+/*
+ * IP cloaking extensions: use ip_cloaking_4.0
+ * if you're linking 3.2 and later, otherwise use
+ * ip_cloaking.so, for compatibility with older 3.x
+ * releases.
+ */
+
+#loadmodule "extensions/ip_cloaking_4.0.so";
+#loadmodule "extensions/ip_cloaking.so";
 
 serverinfo {
        name = "hades.arpa";
        sid = "42X";
        description = "charybdis test server";
-       network_name = "AthemeNET";
+       network_name = "StaticBox";
        network_desc = "Your IRC network.";
        hub = yes;
 
@@ -48,16 +58,19 @@ serverinfo {
        #vhost6 = "3ffe:80e8:546::2";
        
        /* ssl_private_key: our ssl private key */
-       ssl_private_key = "etc/test.key";
+       ssl_private_key = "etc/ssl.key";
 
        /* ssl_cert: certificate for our ssl server */
-       ssl_cert = "etc/test.cert";
+       ssl_cert = "etc/ssl.cert";
 
        /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
        ssl_dh_params = "etc/dh.pem";
 
-       /* ssld_count: number of ssld processes you want to start, if you have a really busy 
-        * server, using N-1 where N is the number of cpu/cpu cores you have might be useful
+       /* ssld_count: number of ssld processes you want to start, if you
+        * have a really busy server, using N-1 where N is the number of
+        * cpu/cpu cores you have might be useful. A number greater than one
+        * can also be useful in case of bugs in ssld and because ssld needs
+        * two file descriptors per SSL connection.
         */
        ssld_count = 1;
 
@@ -67,11 +80,16 @@ serverinfo {
         *   /quote set maxclients <limit>
         */
        default_max_clients = 1024;
+
+       /* nicklen: enforced nickname length (for this server only; must not
+        * be longer than the maximum length set while building).
+        */
+       nicklen = 30;
 };
 
 admin {
        name = "Lazy admin (lazya)";
-       description = "AthemeNET client server";
+       description = "StaticBox client server";
        email = "nobody@127.0.0.1";
 };
 
@@ -92,11 +110,12 @@ log {
  */
 class "users" {
        ping_time = 2 minutes;
-        number_per_ident = 10;
+       number_per_ident = 10;
        number_per_ip = 10;
-        number_per_ip_global = 50;
-       cidr_bitlen = 64;
-       number_per_cidr = 8;
+       number_per_ip_global = 50;
+       cidr_ipv4_bitlen = 24;
+       cidr_ipv6_bitlen = 64;
+       number_per_cidr = 200;
        max_number = 3000;
        sendq = 400 kbytes;
 };
@@ -116,17 +135,24 @@ class "server" {
 };
 
 listen {
+       /* defer_accept: wait for clients to send IRC handshake data before
+        * accepting them.  if you intend to use software which depends on the
+        * server replying first, such as BOPM, you should disable this feature.
+        * otherwise, you probably want to leave it on.
+        */
+       defer_accept = yes;
+
        /* If you want to listen on a specific IP only, specify host.
         * host definitions apply only to the following port line.
         */
        #host = "192.169.0.1";
        port = 5000, 6665 .. 6669;
-       sslport = 9999;
+       sslport = 6697;
 
        /* Listen on IPv6 (if you used host= above). */
        #host = "3ffe:1234:a:b:c::d";
-        #port = 5000, 6665 .. 6669;
-        #sslport = 9999;
+       #port = 5000, 6665 .. 6669;
+       #sslport = 9999;
 };
 
 /* auth {}: allow users to connect to the ircd (OLD I:)
@@ -154,7 +180,7 @@ auth {
         * 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)
         */
-        spoof = "I.still.hate.packets";
+       spoof = "I.still.hate.packets";
 
        /* Possible flags in auth:
         * 
@@ -168,10 +194,11 @@ auth {
         * jupe_exempt                | exempt this user from generating
         *                              warnings joining juped channels
         * resv_exempt                | exempt this user from resvs
-         * flood_exempt               | exempt this user from flood limits
-         *                                     USE WITH CAUTION.
+        * flood_exempt               | exempt this user from flood limits
+        *                                     USE WITH CAUTION.
         * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
         * 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
         */
        flags = kline_exempt, exceed_limit;
@@ -185,14 +212,16 @@ auth {
        class = "users";
 };
 
-/* privsets... XXX document me later */
+/* privset {} blocks MUST be specified before anything that uses them.  That
+ * means they must be defined before operator {}.
+ */
 privset "local_op" {
        privs = oper:local_kill, oper:operwall;
 };
 
 privset "server_bot" {
        extends = "local_op";
-       privs = oper:global_kill, oper:kline, oper:remoteban, snomask:nick_changes;
+       privs = oper:kline, oper:remoteban, snomask:nick_changes;
 };
 
 privset "global_op" {
@@ -233,49 +262,30 @@ operator "god" {
         */
        #umodes = locops, servnotice, operwall, wallop;
 
+       /* fingerprint: if specified, the oper's client certificate
+        * fingerprint will be checked against the specified fingerprint
+        * below.
+        */
+       #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
+
        /* snomask: specific server notice mask on oper up.
         * If this is specified an oper will not be given oper_snomask.
         */
        snomask = "+Zbfkrsuy";
 
-       /* privileges: controls the activities and commands an oper is
-        * allowed to do on the server.  You may prefix an option with ~ to
-        * disable it, ie ~operwall
+       /* flags: misc options for the operator.  You may prefix an option
+        * with ~ to disable it, e.g. ~encrypted.
         *
-        * Default flags are operwall, remoteban and encrypted.
+        * Default flags are encrypted.
         *
         * Available options:
         *
         * encrypted:    the password above is encrypted [DEFAULT]
-        * local_kill:   allows local users to be /KILL'd
-        * global_kill:  allows local and remote users to be 
-        *               /KILL'd                           (OLD 'O' flag)
-        * remote:       allows remote SQUIT and CONNECT   (OLD 'R' flag)
-        * kline:        allows KLINE and DLINE            (OLD 'K' flag)
-        * unkline:      allows UNKLINE and UNDLINE        (OLD 'U' flag)
-        * nick_changes: allows oper to see nickchanges    (OLD 'N' flag)
-        *               via snomask +n
-        * rehash:       allows oper to REHASH config      (OLD 'H' flag)
-        * die:          allows DIE and RESTART            (OLD 'D' flag)
-        * admin:        gives admin privileges.  admins
-        *               may (un)load modules and see the
-        *               real IPs of servers.
-        * hidden_admin: gives admin privileges except
-        *               will not have the admin lines in
-        *               stats p and whois.
-        * xline:        allows use of /quote xline/unxline
-        * resv:         allows /quote resv/unresv and cmode +LP [DEFAULT]
-        * operwall:     allows the oper to send/receive operwalls [DEFAULT]
-        * oper_spy:     allows 'operspy' features to see through +s
-        *               channels etc. see /quote help operspy
-        * hidden_oper:  hides the oper from /stats p    (OLD UMODE +p) 
-        * remoteban:    allows remote kline etc [DEFAULT]
-        * mass_notice:  allows sending wallops and mass notices [DEFAULT]
-         */
-       flags = global_kill, remote, kline, unkline,
-               die, rehash, admin, xline, operwall;
-
-       /* privset: replaces flags */
+        * need_ssl:     must be using SSL/TLS to oper up
+        */
+       flags = encrypted;
+
+       /* privset: privileges set to grant */
        privset = "admin";
 };
 
@@ -288,6 +298,8 @@ connect "irc.uplink.com" {
        class = "server";
        flags = compressed, topicburst;
 
+       #fingerprint = "c77106576abf7f9f90cca0f63874a60f2e40a64b";
+
        /* If the connection is IPv6, uncomment below.
         * Use 0::1, not ::1, for IPv6 localhost. */
        #aftype = ipv6;
@@ -325,39 +337,43 @@ exempt {
 channel {
        use_invex = yes;
        use_except = yes;
-       use_knock = yes;
        use_forward = yes;
+       use_knock = yes;
        knock_delay = 5 minutes;
        knock_delay_channel = 1 minute;
        max_chans_per_user = 15;
-        max_bans = 100;
-        max_bans_large = 500;
+       max_bans = 100;
+       max_bans_large = 500;
        default_split_user_count = 0;
        default_split_server_count = 0;
        no_create_on_split = no;
        no_join_on_split = no;
        burst_topicwho = yes;
        kick_on_split_riding = no;
+       only_ascii_channels = no;
+       resv_forcepart = yes;
+       channel_target_change = yes;
+       disable_local_channels = no;
 };
 
 serverhide {
        flatten_links = yes;
        links_delay = 5 minutes;
-        hidden = no;
+       hidden = no;
        disable_hidden = no;
 };
 
 /* These are the blacklist settings.
  * You can have multiple combinations of host and rejection reasons.
- * They are used in pairs of one host/rejection reason, or multiple hosts/rejection reason.
+ * 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 AthemeNet.
+ * required for use on StaticBox.
  *
  * Word to the wise: Do not use blacklists like SPEWS for blocking IRC
  * connections.
  *
- * As of charybdis 2.1.3, you can do some keyword substitution on the rejection
+ * As of charybdis 2.2, you can do some keyword substitution on the rejection
  * reason. The available keyword substitutions are:
  *
  *   ${ip}           - the user's IP
@@ -366,19 +382,32 @@ serverhide {
  *   ${nick}         - the user's nickname
  *   ${network-name} - the name of the network
  *
+ * As of charybdis 3.4, a type parameter is supported, which specifies the
+ * address families the blacklist supports. IPv4 and IPv6 are supported.
+ * IPv4 is currently the default as few blacklists support IPv6 operation
+ * as of this writing.
+ *
  * Note: AHBL (the providers of the below *.ahbl.org BLs) request that they be
  * contacted, via email, at admins@2mbit.com before using these BLs.
  * See <http://www.ahbl.org/services.php> for more information.
  */
 blacklist {
-       host = "dnsbl.dronebl.org";
-       reject_reason = "${nick}, your IP (${ip}) is listed in DroneBL. For assistance, see http://dronebl.org/lookup_branded.do?ip=${ip}&network=${network-name}";
+       host = "rbl.efnetrbl.org";
+       type = ipv4;
+       reject_reason = "${nick}, your IP (${ip}) is listed in EFnet's RBL. For assistance, see http://efnetrbl.org/?i=${ip}";
 
 #      host = "ircbl.ahbl.org";
+#      type = ipv4;
 #      reject_reason = "${nick}, your IP (${ip}) is listed in ${dnsbl-host} for having an open proxy. In order to protect ${network-name} from abuse, we are not allowing connections with open proxies to connect.";
 #
 #      host = "tor.ahbl.org";
+#      type = ipv4;
 #      reject_reason = "${nick}, your IP (${ip}) is listed as a TOR exit node. In order to protect ${network-name} from tor-based abuse, we are not allowing TOR exit nodes to connect to our network.";
+#
+       /* Example of a blacklist that supports both IPv4 and IPv6 */
+#      host = "foobl.blacklist.invalid";
+#      type = ipv4, ipv6;
+#      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";
 };
 
 alias "NickServ" {
@@ -419,7 +448,11 @@ general {
 
        /*
         * default_umodes: umodes to enable on connect.
-        * If you have enabled the ip_cloaking module, and you want
+        * If you have enabled the new ip_cloaking_4.0 module, and you want
+        * to make use of it, add +x to this option, i.e.:
+        *      default_umodes = "+ix";
+        *
+        * If you have enabled the old ip_cloaking module, and you want
         * to make use of it, add +h to this option, i.e.:
         *      default_umodes = "+ih";
         */
@@ -429,22 +462,23 @@ general {
        default_adminstring = "is a Server Administrator";
        servicestring = "is a Network Service";
        disable_fake_channels = no;
-        tkline_expire_notices = no;
-        default_floodcount = 10;
+       tkline_expire_notices = no;
+       default_floodcount = 10;
        failed_oper_notice = yes;
        dots_in_ident=2;
        min_nonwildcard = 4;
        min_nonwildcard_simple = 3;
-        max_accept = 100;
+       max_accept = 100;
        max_monitor = 100;
        anti_nick_flood = yes;
        max_nick_time = 20 seconds;
        max_nick_changes = 5;
-        anti_spam_exit_message_time = 5 minutes;
+       anti_spam_exit_message_time = 5 minutes;
        ts_warn_delta = 30 seconds;
        ts_max_delta = 5 minutes;
        client_exit = yes;
        collision_fnc = yes;
+       resv_fnc = yes;
        global_snotices = yes;
        dline_with_reason = yes;
        kline_delay = 0 seconds;
@@ -454,6 +488,7 @@ general {
        identify_command = "IDENTIFY";
        non_redundant_klines = yes;
        warn_no_nline = yes;
+       use_propagated_bans = yes;
        stats_e_disabled = no;
        stats_c_oper_only=no;
        stats_h_oper_only=no;
@@ -462,7 +497,7 @@ general {
        stats_P_oper_only=no;
        stats_i_oper_only=masked;
        stats_k_oper_only=masked;
-        map_oper_only = no;
+       map_oper_only = no;
        operspy_admin_only = no;
        operspy_dont_care_user_info = no;
        caller_id_wait = 1 minute;
@@ -471,21 +506,24 @@ general {
        short_motd = no;
        ping_cookie = no;
        connect_timeout = 30 seconds;
+       default_ident_timeout = 5;
        disable_auth = no;
        no_oper_flood = yes;
        max_targets = 4;
-       client_flood = 20;
-        use_whois_actually = no;
+       client_flood_max_lines = 20;
+       use_whois_actually = no;
        oper_only_umodes = operwall, locops, servnotice;
        oper_umodes = locops, servnotice, operwall, wallop;
        oper_snomask = "+s";
-        burst_away = yes;
+       burst_away = yes;
        nick_delay = 0 seconds; # 15 minutes if you want to enable this
        reject_ban_time = 1 minute;
        reject_after_count = 3;
        reject_duration = 5 minutes;
        throttle_duration = 60;
        throttle_count = 4;
+       max_ratelimit_tokens = 30;
+       away_interval = 30;
 };
 
 modules {