]> jfr.im git - solanum.git/blobdiff - doc/reference.conf
Fix comment in example configuration
[solanum.git] / doc / reference.conf
index ac8263085aa3a64692e3d78d17872b7da1f5fb52..368c5a70ce3d8c433b522a3718eea14013de7727 100644 (file)
  *        .include "filename"
  *        .include <filename>
  *
+ * Flags variables are comma-separated sets of predefined values,
+ * specific to each block. For example in operator {} blocks:
+ *        flags = encrypted, encrypted;
+ *
  * Times/durations are written as:
  *        12 hours 30 minutes 1 second
  *
@@ -72,7 +76,6 @@
  * Far connection notices (snomask +F)               -- sno_farconnect
  * 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/sno_farconnect";
 #loadmodule "extensions/sno_globalnickchange";
 #loadmodule "extensions/sno_globaloper";
-#loadmodule "extensions/sno_whois";
 #loadmodule "extensions/override";
 #loadmodule "extensions/no_kill_services";
 
@@ -376,13 +378,13 @@ auth {
         * exceed_limit (old > flag)  | allow user to exceed class user limits
         * kline_exempt (old ^ flag)  | exempt this user from k/g/xlines,
         *                            | dnsbls, and proxies
-        * dnsbl_exempt               | exempt this user from dnsbls
+        * 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
+        * spambot_exempt             | exempt this user from spambot checks
+        * shide_exempt               | exempt this user from serverhiding
         * jupe_exempt                | exempt this user from generating
         *                              warnings joining juped channels
-        * resv_exempt                | exempt this user from resvs
+        * resv_exempt                | exempt this user from resvs
         * flood_exempt               | exempt this user from flood limits
         *                                     USE WITH CAUTION.
         * no_tilde     (old - flag)  | don't prefix ~ to username if no ident
@@ -458,7 +460,7 @@ privset "local_op" {
         * oper:wallops:         allows sending wallops messages
         * oper:grant:           allows using the GRANT command
         * usermode:servnotice:  allows setting +s
-        * oper:message:         allows opers to bypass CALLERID (usermode +g)
+        * oper:message:         allows opers to bypass CALLERID (usermode +g)
         *
         * Privileges provided by extensions include:
         *
@@ -546,12 +548,21 @@ operator "god" {
        privset = "admin";
 };
 
-/* connect {}: controls servers we connect to (OLD C:, N:, H:, L:) */
+/* connect {}: controls servers we connect with (OLD C:, N:, H:, L:).
+ *
+ * This configuration is used whether connections are incoming or
+ * outgoing.
+ */
 connect "irc.uplink.com" {
-       /* the name must go above */
+       /* the name of the other server must go above. It should match the
+        * other server's name in its serverinfo {} block, and does not
+        * need to be an actual hostname.
+        */
 
-       /* host: the host or IP to connect to.  If a hostname is used it
-        * must match the reverse dns of the server.
+       /* host: the host or IP to connect to.
+        *
+        * It is also used to validate incoming connections. If a hostname
+        * is used, it must match the reverse dns of the server.
         */
        host = "203.0.113.3";
 
@@ -579,10 +590,10 @@ connect "irc.uplink.com" {
        class = "server";
 
        /* flags: controls special options for this server
-        * encrypted    - marks the accept_password as being crypt()'d
-        * autoconn     - automatically connect to this server
-        * topicburst   - burst topics between servers
-        * ssl          - ssl/tls encrypted server connections
+        * encrypted    - marks the accept_password as being crypt()'d
+        * autoconn     - automatically connect to this server
+        * topicburst   - burst topics between servers
+        * ssl          - ssl/tls encrypted server connections
         * no-export    - marks the link as a no-export link (not exported to other links)
         */
        flags = topicburst;
@@ -1146,6 +1157,52 @@ general {
         */
        kline_reason = "Connection closed";
 
+       /* SASL access only client message: give users a message that
+        * informs them
+        */
+       sasl_only_client_message = "You need to identify via SASL to use this server.";
+
+       /* Identd access only client message: give users a message that
+        * informs them
+        */
+       identd_only_client_message = "You need to install identd to use this server.";
+
+       /* SCTP forbidden client message: give users a message that
+        * informs them
+        */
+       sctp_forbidden_client_message = "You are not allowed to use SCTP on this server.";
+
+       /* SSL/TLS access only client message: give users a message that
+        * informs them
+        */
+       ssltls_only_client_message = "You need to use SSL/TLS to use this server.";
+
+       /* Not authorised client message: tell users that they are not
+        * authorised
+        */
+       not_authorised_client_message = "You are not authorised to access this server.";
+
+       /* Illegal hostname client message: tell users that they have illegal
+        * chars in their hostname
+        */
+       illegal_hostname_client_message = "You have an illegal character in your hostname.";
+
+       /* Server full client message: tell users that the server they're connecting
+        * to is full
+        */
+       server_full_client_message = "Sorry, server is full - try later";
+
+       /* illegal name long client message: long-form explanation that their username
+        * contains illegal characters
+        */
+       illegal_name_long_client_message = "Your username is invalid. Please make sure that your username contains "
+                                                                          "only alphanumeric characters.";
+
+       /* illegal name short client message: short-form notification that their username
+        * contains illegal characters; will be followed by ": their_username"
+        */
+       illegal_name_short_client_message = "Invalid username";
+
        /* identify to services via server password
         * if auth{} block had no password but the user specified a
         * server password anyway, send a PRIVMSG to <identify_service>
@@ -1397,6 +1454,11 @@ general {
 
        /* oper_secure_only: require TLS on any connection trying to oper up */
        oper_secure_only = no;
+
+       /* drain_reason: Message shown to users when they are rejected from a draining server.
+        * requires extensions/drain to be loaded.
+        */
+       drain_reason = "This server is not accepting connections.";
 };
 
 modules {