]> git.netwichtig.de Git - user/henk/code/inspircd.git/blobdiff - docs/inspircd.conf.example
Add config <options:disablehmac> to support disabling of HMAC, and tidy up to detect...
[user/henk/code/inspircd.git] / docs / inspircd.conf.example
index a8caf138bb2e32b1ef4b6fa47bb9d2b29a508349..b26ee7ef205949a50d7b2104df9a07518b677f39 100644 (file)
@@ -67,9 +67,9 @@
 #              email="email@address.com">                             #
 #                                                                     #
 
-<admin  name="Johnny English"
-        nick="MI5"
-        email="MI5@the.best.secret.agent">
+<admin name="Johnny English"
+       nick="MI5"
+       email="MI5@the.best.secret.agent">
 
 
 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 #       <oper name="login"                                            #
 #             password="pass"                                         #
 #             host="hostmask@of.oper"                                 #
-#             fingerprint="hexsequence"                               #
+#           fingerprint="hexsequence"                               #
 #             type="oper type">                                       #
 #                                                                     #
 
-<oper   name="Brain"
-        password="s3cret"
-        host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
-        type="NetAdmin">
+<oper name="Brain"
+      password="s3cret"
+      host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
+      type="NetAdmin">
 
 
 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #                 looking for the error 'Could not assign requested   #
 #                 address' in your log when connecting to servers.    #
 #                                                                     #
+# hidden        - If this is set to true, yes, or 1, then the server  #
+#                 is completely hidden from non-opers. It does not    #
+#                 show in LINKS and it does not show in MAP. Also,    #
+#                 any servers which are child servers of this one     #
+#                 in the network will *also* be hidden. Use with      #
+#                 care! You can use this to 'mask off' sections of    #
+#                 the network so that users only see a small portion  #
+#                 of a much larger net. It should NOT be relied upon  #
+#                 as a security tool, unless it is being used for     #
+#                 example to hide a non-client hub, for which clients #
+#                 do not have an IP address or resolvable hostname.   #
+#                                                                     #
 # 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.    #
 #                                                                     #
 
 <link name="hub.penguin.org"
-        ipaddr="penguin.box.com"
-        port="7000"
-        allowmask="69.58.44.0/24"
-        autoconnect="300"
-        failover="hub.other.net"
-        timeout="15"
-        transport="gnutls"
-       bind="1.2.3.4"
-        sendpass="outgoing!password"
-        recvpass="incoming!password">
+      ipaddr="penguin.box.com"
+      port="7000"
+      allowmask="69.58.44.0/24"
+      autoconnect="300"
+      failover="hub.other.net"
+      timeout="15"
+      transport="gnutls"
+      bind="1.2.3.4"
+      hidden="no"
+      sendpass="outgoing!password"
+      recvpass="incoming!password">
 
 <link name="services.antarctic.com"
-        ipaddr="localhost"
-        port="7000"
-        allowmask="127.0.0.0/8"
-        sendpass="penguins"
-        recvpass="polarbears">
+      ipaddr="localhost"
+      port="7000"
+      allowmask="127.0.0.0/8"
+      sendpass="penguins"
+      recvpass="polarbears">
+
 
-<uline server="services.antarctic.com">
+#-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
+# This tag defines a ulined server. A U-Lined server has special      #
+# permissions, and should be used with caution. Services servers are  #
+# usually u-lined in this manner.                                     #
+#                                                                     #
+# The 'silent' value if set to yes indicates that this server should  #
+# not generate quit and connect notices, which can cut down on noise  #
+# to opers on the network.                                            #
+#                                                                     #
+<uline server="services.antarctic.com" silent="yes">
 
 
 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 #   configurtion directory.                                           #
 #                                                                     #
 
-<files  motd="inspircd.motd"
-        rules="inspircd.rules">
+<files motd="inspircd.motd"
+       rules="inspircd.rules">
 
 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 #                                                                     #
 #   Settings to define which features are useable on your server.     #
 #                                                                     #
-#  prefixquit    - a prefix for a client's quit message               #
+#  prefixquit    - A prefix to be placed on the start of a client's   #
+#                  quit message                                       #
+#                                                                     #
+#  suffixquit    - A suffix to be placed on the end of a client's     #
+#                  quit message.                                      #
+#                                                                     #
+#  fixedquit     - A fixed quit message to display for all client     #
+#                  QUITS. If specified, overrides both prefixquit     #
+#                  and suffixquit options.                            #
 #                                                                     #
 #  loglevel      - specifies what detail of messages to log in the    #
 #                  log file. You may select from debug, verbose,      #
 #                  of text sent out. Eg. NOTICE @#test :@ testing     #
 #                  vs. the off setting: NOTICE @#test :testing        #
 #                                                                     #
-#  notimesync    - If this value is 'yes', 'true', or '1', time       #
-#                  synchronization is disabled on this server. This   #
-#                  means any servers you are linked to will not       #
-#                  automatically synchronize time with you, and in    #
-#                  most cases will just result in more bounced modes  #
-#                  on netsplits. This option should be the same on    #
-#                  all servers.                                       #
-#                                                                     #
 #  hostintopic   - If this is set to yes (the default) then the full  #
 #                  nick!user@host is shown for who set a TOPIC last.  #
 #                  if set to no, then only the nickname is shown.     #
 #                                                                     #
+# announceinvites                                                     #
+#                - If this option is set to yes (the default), then   #
+#                  invites are announced to the channel when a user   #
+#                  invites annother user. If you consider this to be  #
+#                  unnecessary noise, explicitly set this to no.      #
+#                                                                     #
+#  disablehmac   - If you are linking your InspIRCd to older versions #
+#                  then you can specify this option and set it to     #
+#                  yes. 1.1.6 and above support HMAC and challenge-   #
+#                  response for password authentication. These can    #
+#                  greatly enhance security of your server to server  #
+#                  connections when you are not using SSL (as is the  #
+#                  case with a lot of larger networks). Linking to    #
+#                  older versions of InspIRCd should not *usually* be #
+#                  a problem, but if you have problems with HMAC      #
+#                  authentication, this option can be used to turn it #
+#                  off.                                               #
+#                                                                     #
 
 <options prefixquit="Quit: "
          loglevel="default"
          cyclehosts="yes"
          ircumsgprefix="no"
          announcets="yes"
-         notimesync="no"
-        hostintopic="yes"
+        disablehmac="no"
+         hostintopic="yes"
          allowhalfop="yes">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#- TIME SYNC OPTIONS -#-#-#-#-#-#-#-#-#-#-#-#
+# Time sychronization options for m_spanningtree linking.             #
+#                                                                     #
+# Because IRC is very time and clock dependent, InspIRCd provides its #
+# own methods for syncronization of time between servers as shown     #
+# in the example below, for servers that don't have ntpd running.     #
+#                                                                     #
+#  enable    -     If this value is 'yes', 'true', or '1', time       #
+#                  synchronization is enabled on this server. This    #
+#                  means any servers you are linked to will           #
+#                  automatically synchronize time, however you should #
+#                  use ntpd instead where possible, NOT this option.  #
+#                                                                     #
+#  master    -     If this value is set to yes, then this server will #
+#                  act as the authoritative time source for the whole #
+#                  network. All other servers will respect its time   #
+#                  without question, and match their times to it.     #
+#                  only one server should have the master value set   #
+#                  to 'yes'.                                          #
+#                                                                     #
+<timesync enable="no" master="no">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 #                                                                     #
 # This tag lets you define the behaviour of the /whowas command of    #
 #<alias text="ID" replace="PRIVMSG NickServ :IDENTIFY $2"
 #  requires="NickServ" uline="yes">
 #
+# This alias fixes a glitch in xchat 2.6.x and above and the way it
+# assumes IDENTIFY must be prefixed by a colon (:) character. It should
+# be placed ABOVE the default NICKSERV alias (the first example) listed
+# above.
+#
+#<alias text="NICKSERV" format=":IDENTIFY *" replace="PRIVMSG NickServ :IDENTIFY $3-"
+#  requires="NickServ" uline="yes">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Alltime module: Shows time on all connected servers at once
 # minlen         - The minimum length a line must be for the block    #
 #                  percent to have any effect.                        #
 #                                                                     #
-#<blockcaps percent="95" minlen="5">
+# capsmap        - A list of chars to be considered CAPS, this was    #
+#                  you can add CAPS for your language. Also you can   #
+#                  add things like ! and space to further lock down   #
+#                  on caps usage.                                     #
+#<blockcaps percent="50"
+#           minlen="5"
+#           capsmap="ABCDEFGHIJKLMNOPQRSTUVWXYZ! ">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Block colour module: Blocking colour-coded messages with cmode +c
 #
 #<include file="censor.conf">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# CGI:IRC module: Adds support for automatic host changing in CGI:IRC
+# (http://cgiirc.sourceforge.net).
+#<module name="m_cgiirc.so">
+#
+#-#-#-#-#-#-#-#-#-#-#-# CGIIRC  CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
+#
+# Optional - If you specify to use m_cgiirc, then you must specify one
+# or more cgihost tags which indicate authorized CGI:IRC servers which
+# will be connecting to your network, and an optional cgiirc tag.
+# For more information see: http://www.inspircd.org/wiki/CGI-IRC_Module
+#
+# Set to yes if you want to notice opers when CGI clients connect
+# <cgiirc opernotice="no">
+#
+# The type field indicates where the module should get the real
+# client's IP address from, for further information, please see the
+# CGI:IRC documentation.
+#
+# <cgihost type="pass" mask="www.mysite.com">       # Get IP from PASS
+# <cgihost type="webirc" mask="somebox.mysite.com"> # Get IP from WEBIRC
+# <cgihost type="ident" mask="otherbox.mysite.com"> # Get IP from ident
+# <cgihost type="passfirst" mask="www.mysite.com">  # See the docs
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Channel filter module: Allows channel-op defined message
 # filtering using simple string matches (channel mode +g)
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CHGHOST module: Adds the /CHGHOST command
 #<module name="m_chghost.so">
+#
+#-#-#-#-#-#-#-#-# /CHGHOST - /SETHOST  CONFIGURATION #-#-#-#-#-#-#-#-#
+# Optional - If you want to use special chars for hostnames you can  #
+# specify your own custom list of chars with the <hostname> tag:     #
+#                                                                    #
+# charmap        - A list of chars accepted as valid by the /CHGHOST #
+#                  and /SETHOST commands. Also note that the list is # 
+#                  case-sensitive.                                   #
+#<hostname charmap="abcdefghijklmnopqrstuvwxyz.-_/0123456789">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # CHGIDENT module: Adds the /CHGIDENT command
 # Join flood module: Adds support for join flood protection (+j)
 #<module name="m_joinflood.so">
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# Jump Server module: Adds support for the RPL_REDIR numeric
+#<module name="m_jumpserver.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Anti-Auto-Rejoin: Adds support for prevention of auto-rejoin (+J)
 #<module name="m_kicknorejoin.so">
 #
 #-#-#-#-#-#-#-#-#-#-# SAFELIST CONFIGURATION -#-#-#-#-#-#-#-#-#-#-#-#-#
 #
-# When using Safelist, you may set the following value, which sets the
-# amount of time in seconds a user must wait between LIST commands.
-# For example, if this is set to 60 (the default) then the user may not
-# /LIST more than once a minute. If not defined, the default value is
-# 60 seconds.
+# When using Safelist, you may set the following values;
+#
+# The first value, 'throttle', sets the amount of time in seconds a user
+# must wait between LIST commands. For example, if this is set to 60
+# (the default) then the user may not /LIST more than once a minute.
+# If not defined, the default value is 60 seconds.
 #
-#<safelist throttle="60">
+# The second value, 'maxlisters', indicates the maximum number of users
+# which may be retrieving a LIST at once. It is not recommended you raise
+# this value, as increasing it too high can make your network vulnerable
+# to floodbots which waste your bandwidth and CPU time with LIST requests.
+#
+#<safelist throttle="60" maxlisters="50">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # SAJOIN module: Adds the /SAJOIN command
 # Securelist can be harmful to some irc search engines such as        #
 # netsplit.de and searchirc.com. To prevent securelist blocking these #
 # sites from listing, define exception tags as shown below:           #
-<securelist exception="*@*.searchirc.org">                            #
-<securelist exception="*@*.netsplit.de">                              #
+<securelist exception="*@*.searchirc.org">
+<securelist exception="*@*.netsplit.de">
+<securelist exception="*@echo940.server4you.de">
 #                                                                     #
 # Define the following variable to change how long a user must wait   #
 # before issuing a LIST. If not defined, defaults to 60 seconds.      #
 #                                                                     #
 #<securelist waittime="60">                                           #
 
+#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
+# See nicks module: Allow for SNOMASK +N which shows nick changes.
+#<module name="m_seenicks.so">
+
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Set Idle module: Adds a command for opers to change their
 # idle time (mainly a toy)
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 # Sethost module: Adds the /SETHOST command
+# See m_chghost for how to customise valid chars for hostnames
 #<module name="m_sethost.so">
 
 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#