From 4aeda51771f6fcc2b0d548fa33394af59038aedd Mon Sep 17 00:00:00 2001
From: danieldg <danieldg@e03df62e-2008-0410-955e-edbf42e46eb7>
Date: Tue, 9 Feb 2010 05:35:19 +0000
Subject: Clean up documentation of connect blocks a bit

git-svn-id: http://svn.inspircd.org/repository/trunk/inspircd@12410 e03df62e-2008-0410-955e-edbf42e46eb7
---
 docs/inspircd.conf.example | 16 +++++++++++++---
 1 file changed, 13 insertions(+), 3 deletions(-)

(limited to 'docs')

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index 5a5a6c7c5..43afc22f0 100644
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -20,7 +20,6 @@
 #         This is an example of the config file for InspIRCd.          #
 #             Change the options to suit your network                  #
 #                                                                      #
-#     $Id$
 #                                                                      #
 #    ____                _   _____ _     _       ____  _ _   _         #
 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
@@ -214,7 +213,14 @@
 #    and allow tags at the top, progressively more general, followed  #
 #        by a <connect allow="*" (should you wish to have one).       #
 #                                                                     #
-#                                                                     #
+# Connect blocks are searched twice for each user - once when the TCP #
+# connection is accepted, and once when the user completes their      #
+# registration. Most of the information (hostname, ident response,    #
+# password, SSL when using STARTTLS, etc) is only available during    #
+# the second search, so if you are trying to make a closed server,    #
+# you will probably need a connect block just for user registration.  #
+# This can be done by using <connect registered="no">                 #
+
 <connect
          # deny: Will not let people connect if they have specified host/IP.
          deny="69.254.*">
@@ -279,9 +285,13 @@
          # block have a valid ident response, use SSL, or have authenticated.
          # Requires m_ident, m_sslinfo, or m_services_account respectively.
          requiressl="on"
+         # NOTE: For requireaccount, you must complete the signon prior to full
+         # connection. Currently, this is only possible by using SASL
+         # authentication; passforward and PRIVMSG NickServ happen after
+         # your final connect block has been found.
 
          # Alternate MOTD file for this connect class. The contents of this file are
-		 # specified using <files secretmotd="filename"> or <execfiles ...>
+         # specified using <files secretmotd="filename"> or <execfiles ...>
          motd="secretmotd"
 
          # port: What port this user is allowed to connect on. (optional)
-- 
cgit v1.2.3