]> jfr.im git - solanum.git/blobdiff - doc/reference.conf
Ginormous docs cleanup.
[solanum.git] / doc / reference.conf
old mode 100755 (executable)
new mode 100644 (file)
index 78d107a..19e337c
@@ -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:
  * Charybdis contains several extensions that are not enabled by default.
  * To use them, uncomment the lines below.
  *
- * Channel mode +-A (admin only)                     -- chm_adminonly.so
- * Channel mode +-O (oper only)                      -- chm_operonly.so
- * Channel mode +-S (ssl only)                       -- chm_sslonly.so
- * Emulates channel mode +-O (oper only) (+-iI $o)   -- chm_operonly_compat.so
- * Emulates channel mode +-R (quiet unreg) (+-q $~a) -- chm_quietunreg_compat.so
- * Emulates channel mode +-S (ssl only) (+-b $~z)    -- chm_sslonly_compat.so
- * Restrict channel creation to logged in users      -- createauthonly.so
- * Account bans (+b $a[:mask])                       -- extb_account.so
- * Banned from another channel (+b $j:mask)          -- extb_canjoin.so
- * Other-channel bans (+b $c:mask)                   -- extb_channel.so
- * Extended ban (+b $x:mask)                         -- extb_extgecos.so
- * Oper bans (+b $o)                                 -- extb_oper.so
- * Realname (gecos) bans (+b $r:mask)                -- extb_realname.so
- * Server bans (+b $s:mask)                          -- extb_server.so
- * SSL bans (+b $z)                                  -- extb_ssl.so
- * HURT system                                       -- hurt.so
- * New host mangling (umode +x)                      -- ip_cloaking_4.0.so
- * Old host mangling (umode +h)                      -- ip_cloaking.so
- * Find channel forwards                             -- m_findforwards.so
- * /identify support                                 -- m_identify.so
- * Opers cannot be invisible (umode +i)              -- no_oper_invis.so
- * Far connection notices (snomask +F)               -- sno_farconnect.so
- * Remote k/d/x line active notices                  -- sno_globalkline.so
- * Remote oper up notices                            -- sno_globaloper.so
- * /whois notifications (snomask +W)                 -- sno_whois.so
- * Oper-override (modehacking only)                  -- override.so
- * Stop services kills                               -- no_kill_services.so
+ * 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
+ * Channel mode +-M (disallow KICK on IRC ops)       -- chm_operpeace.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
+ * Helpops system (umode +H)                         -- helpops.la
+ * HURT system                                       -- hurt.la
+ * New host mangling (umode +x)                      -- ip_cloaking_4.0.la
+ * Old host mangling (umode +h)                      -- ip_cloaking.la
+ * Dynamically extend channel limits                 -- m_extendchans.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
+ * Global nick-change notices                        -- sno_globalnickchange.la
+ * /whois notifications (snomask +W)                 -- sno_whois.la
+ * Oper-override (modehacking only)                  -- override.la
+ * Stop services kills                               -- no_kill_services.la
  */
-#loadmodule "extensions/chm_adminonly.so";
-#loadmodule "extensions/chm_operonly.so";
-#loadmodule "extensions/chm_sslonly.so";
-#loadmodule "extensions/chm_operonly_compat.so";
-#loadmodule "extensions/chm_quietunreg_compat.so";
-#loadmodule "extensions/chm_sslonly_compat.so";
-#loadmodule "extensions/createauthonly.so";
-#loadmodule "extensions/extb_account.so";
-#loadmodule "extensions/extb_canjoin.so";
-#loadmodule "extensions/extb_channel.so";
-#loadmodule "extensions/extb_extgecos.so";
-#loadmodule "extensions/extb_oper.so";
-#loadmodule "extensions/extb_realname.so";
-#loadmodule "extensions/extb_server.so";
-#loadmodule "extensions/extb_ssl.so";
-#loadmodule "extensions/hurt.so";
-#loadmodule "extensions/ip_cloaking_4.0.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_farconnect.so";
-#loadmodule "extensions/sno_globalkline.so";
-#loadmodule "extensions/sno_globaloper.so";
-#loadmodule "extensions/sno_whois.so";
-#loadmodule "extensions/override.so";
-#loadmodule "extensions/no_kill_services.so";
+#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/chm_operpeace.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/helpops.la";
+#loadmodule "extensions/hurt.la";
+#loadmodule "extensions/ip_cloaking_4.0.la";
+#loadmodule "extensions/ip_cloaking.la";
+#loadmodule "extensions/m_extendchans.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_globalnickchange.la";
+#loadmodule "extensions/sno_globaloper.la";
+#loadmodule "extensions/sno_whois.la";
+#loadmodule "extensions/override.la";
+#loadmodule "extensions/no_kill_services.la";
 
 /* serverinfo {}:  Contains information about the server. (OLD M:) */
 serverinfo {
@@ -147,6 +158,9 @@ serverinfo {
        /* ssl_dh_params: DH parameters, generate with openssl dhparam -out dh.pem 1024 */
        ssl_dh_params = "etc/dh.pem";
 
+       /* ssl_cipher_list: A list of ciphers, dependent on your TLS backend */
+       #ssl_cipher_list = "EECDH+HIGH:EDH+HIGH:HIGH:!aNULL";
+
        /* 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
@@ -369,6 +383,7 @@ 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;
        
@@ -424,6 +439,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;
 };
@@ -442,7 +458,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:) */
@@ -553,7 +569,7 @@ connect "irc.uplink.com" {
        flags = compressed, topicburst;
 };
 
-connect "ipv6.some.server" {
+connect "ipv6.lame.server" {
        /* Hosts that are IPv6 addresses must be in :: shortened form
         * if applicable.  Addresses starting with a colon get an extra
         * zero prepended, for example: 0::1
@@ -660,6 +676,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
         */
 
@@ -726,6 +745,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;
 
@@ -790,6 +812,20 @@ channel {
         * supported.
         */
        disable_local_channels = no;
+
+       /* autochanmodes: the channel modes that should be automatically set
+        * when a channel is created.
+        */
+       autochanmodes = "+nt";
+
+       /* displayed_usercount: the minimum amount of users on a channel before it
+        * is displayed in LIST.  this parameter can be overridden using ELIST parameters,
+        * such as LIST >0.
+        */
+       displayed_usercount = 3;
+
+       /* strip_topic_colors: whether or not color codes in TOPIC should be stripped. */
+       strip_topic_colors = no;
 };
 
 
@@ -1294,6 +1330,15 @@ general {
         * counts.
         */
        away_interval = 30;
+
+       /* certfp_method: the method that should be used for computing certificate fingerprints.
+        * Acceptable options are sha1, sha256 and sha512.  Networks running versions of charybdis
+        * 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 {
@@ -1304,5 +1349,5 @@ modules {
        path = "/usr/local/ircd/modules/autoload";
 
        /* module: the name of a module to load on startup/rehash */
-       #module = "some_module.so";
+       #module = "some_module.la";
 };