Added tons of services/uline stuff. DO NOT USE YET! services data isnt replicated...

[user/henk/code/inspircd.git] / docs / inspircd.conf.example

diff --git a/docs/inspircd.conf.example b/docs/inspircd.conf.example
index 34316ab718fcd3efe997c0c639c6ed586e6525af..9ecf02f5f35560b9c59284003fe1cd419f0783cc 100644 (file)
--- a/docs/inspircd.conf.example
+++ b/docs/inspircd.conf.example
@@ -57,7 +57,7 @@
 #  port                - opens an unused port                                #
 #  type         - can be 'clients' or 'servers'. The clients type is  #
 #                 a standard tcp based socket, the servers type is a  #
-                  UDP based connection.                               #
+#                 UDP based connection.                               #
 #  default      - if the port type is 'servers' then this can be      #
 #                 specified. If set to 'yes', it indicates that this  #
 #                 port is the default route for all /connect commands.#
@@ -86,7 +86,7 @@
 #   need this ability should know the die and restart password.       #
 #                                                                     #
 #  Syntax is as follows:                                              #
-#       <power diepass="die password" restartpass="restart password"
+#       <power diepass="die password" restartpass="restart password"  #
 #       pause="secs before dying">                                   #
 #                                                                     #
 
@@ -103,12 +103,23 @@
 #                                                                    #
 #  Syntax is as follows:                                             #
 #      <connect allow="ip number">                                   #
-#      <connect allow="ip number"  password="blahblah">              #
+#      <connect allow="ip number" password="blahblah">               #
+#       <connect allow="ip number" password="blah" timeout="10">      #
+#      <connect allow="ip number" timeout="blah" flood="5">          #
 #      <connect deny="ip number">                                    #
+#                                                                     #
+#   You may optionally include timeout="x" on any allow line, which   #
+#   specifies the amount of time given before an unknown connection   #
+#   is closed if USER/NICK/PASS are not given. This value is in secs  #
 #                                                                    #
+#   You may also optionally include a flood="x" line which indicates  #
+#   the number of lines a user may place into their buffer at once    #
+#   before they are disconnected for excess flood. The default is to  #
+#   DISABLE this feature. A recommended value is 10.                  #
+
 
-<connect allow="196.12.*"  password="tiffany">
-<connect allow="*">
+<connect allow="196.12.*"  password="secret">
+<connect allow="*" timeout="60" flood="10">
 
 <connect deny="69.254.*">
 
@@ -177,7 +188,47 @@
         type="NetAdmin">
 
 
-#-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION   -#-#-#-#-#-#-#-#-#-
+#-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
+#                                                                     #
+# Defines which servers can link to this one, and which servers this  #
+# server may create outbound links to.                                #
+#                                                                     #
+# name      - The name is the canocial name of the server, it does    #
+#             not have to resolve - but it is expected to be sent in  #
+#             the remote servers connection info.                     #
+# ipaddr    - Valid ip address for remote server.                     #
+# port      - Valid listening UDP port for remote server.             #
+# sendpass  - Password to send to create an outbound connection to    #
+#             this server.                                            #
+# recvpass  - Password to receive to accept an inbound connection     #
+#             from this server.                                       #
+#                                                                     #
+# to u:line a server (give it extra privilages required for running   #
+# services, Q, etc) you must include the <uline server> tag as shown  #
+# in the example below. You can have as many of these as you like.    #
+#                                                                     #
+# WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
+# that server to operoverride modes. This should only be used for     #
+# services and protected oper servers!                                #
+#                                                                     #
+
+<link name="hub.penguin.org"
+       ipaddr="12.34.56.78"
+       port="7000"
+       sendpass="outgoing!password"
+       recvpass="incoming!password">
+
+<link name="services.antarctic.com"
+       ipaddr="98.76.54.32"
+       port="7000"
+       sendpass="penguins"
+       recvpass="polarbears">
+
+<uline server="services.antarctic.com">
+
+
+
+#-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                                                                    #
 #   These options let you define the path to your motd and rules      #
 #   files.                                                           #
@@ -201,17 +252,20 @@
 #                                                                    #
 #   Settings to define which features are useable on your server.     #
 #                                                                    #
-#  prefixquit   - a prefix for a client's quit message                #
-#  loglevel     - specifies what detail of messages to log in the     #
-#                 log file. You may select from debug, verbose,       #
-#                 default, sparse and none.                           #
-#  allowhalfop  - allows the +h channel mode                         #
-#  allowprotect - allows the +a channel mode                         #
-#  allowfounder - allows the +q channel mode                         #
-#                                                                    #
+#  prefixquit    - a prefix for a client's quit message               #
+#  loglevel      - specifies what detail of messages to log in the    #
+#                  log file. You may select from debug, verbose,      #
+#                  default, sparse and none.                          #
+#  allowhalfop   - allows the +h channel mode                        #
+#  allowprotect  - allows the +a channel mode                        #
+#  allowfounder  - allows the +q channel mode                        #
+#  netbuffersize - size of the buffer used to receive data from       #
+#                  clients. The ircd may only read() this amount      #
+#                 of text in one go at any time. (OPTIONAL)          #
 
 <options prefixquit="Quit: "
         loglevel="default"
+        netbuffersize="10240"
         allowhalfop="yes"
         allowprotect="yes"
         allowfounder="yes">