docs/inspircd.conf.example

   1 ########################################################################
   2 #                                                                      #
   3 #                     ---------------------------                      #
   4 #                     InspIRCd Configuration File                      #
   5 #                     ---------------------------                      #
   6 #                                                                      #
   7 ##################################||####################################
   8                                  #||#
   9 ##################################||####################################
  10 #                                                                      #
  11 #         This is an example of the config file for InspIRCd.          #
  12 #             Change the options to suit your network                  #
  13 #                                                                      #
  14 #                 Last updated on : 30/10/2002                         #
  15 #                 Written by      : CC  (cc@backchat.co.za)            #
  16 #                                                                      #
  17 ########################################################################
  18
  19
  20
  21 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
  22 #                                                                     #
  23 #   Here is where you enter the information about your server.        #
  24 #                                                                     #
  25 #  Syntax is as follows:                                              #
  26 #     <server name="server.name"                                      #
  27 #      description="Server Description"                               #
  28 #      network="MyNetwork">                                           #
  29 #                                                                     #
  30
  31 <server name="penguin.omega.org.za"
  32         description="Waddle World"
  33         network="Omega">
  34
  35
  36 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
  37 #                                                                     #
  38 #   Describes the Server Administrator's real name, nick              #
  39 #   and email address.                                                #
  40 #                                                                     #
  41 #  Syntax is as follows:                                              #
  42 #       <admin name="real name"                                       #
  43 #              nick="nick name"                                       #
  44 #              email="email@address.com">                             #
  45 #                                                                     #
  46
  47 <admin  name="Johnny Casino"
  48         nick="CC"
  49         email="cc@monkeynut.co.za">
  50
  51
  52 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
  53 #                                                                     #
  54 #   Enter the port and address bindings here.                         #
  55 #                                                                     #
  56 #  bind address - specifies which the address which ports bind        #
  57 #  port         - opens an unused port                                #
  58 #                                                                     #
  59 #  Leaving address empty binds to all available interfaces            #
  60 #                                                                     #
  61 #  Syntax is as follows:                                              #
  62 #       <bind address="ip number" port="port number">                 #
  63 #                                                                     #
  64
  65 <bind address="" port="6667">
  66 <bind address="" port="7000">
  67
  68
  69 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
  70 #                                                                     #
  71 #   You can configure the passwords here which you wish to use for    #
  72 #   the die and restart commands. Only trusted ircops who will        #
  73 #   need this ability should know the die and restart password.       #
  74 #                                                                     #
  75 #  Syntax is as follows:                                              #
  76 #       <power diepass="die password" restartpass="restart password"
  77 #        pause="secs before dying">                                   #
  78 #                                                                     #
  79
  80 <power diepass="diepass" restartpass="restartpass" pause="2">
  81
  82
  83 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
  84 #                                                                     #
  85 #   This is where you can configure which connections are allowed     #
  86 #   and denied access onto your server.                               #
  87 #   The password is optional.                                         #
  88 #   You may have as many of these as you require.                     #
  89 #   To allow/deny all connections use a *                             #
  90 #                                                                     #
  91 #  Syntax is as follows:                                              #
  92 #       <connect allow="ip number">                                   #
  93 #       <connect allow="ip number"  password="blahblah">              #
  94 #       <connect deny="ip number">                                    #
  95 #                                                                     #
  96
  97 <connect allow="196.12.*"  password="tiffany">
  98 <connect allow="*">
  99
 100 <connect deny="69.254.*">
 101
 102
 103 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 104 #                                                                     #
 105 #   Classes are a group of commands which are grouped together        #
 106 #   and given a unique name. They used to define which commands       #
 107 #   are available to certain types of Operators.                      #
 108 #                                                                     #
 109 #  Syntax is as follow:                                               #
 110 #       <class name="name" commands="oper commands">                  #
 111 #                                                                     #
 112
 113 <class name="Shutdown" commands="DIE RESTART REHASH">
 114 <class name="ServerLink" commands="CONNECT SQUIT">
 115 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE SHUN">
 116 <class name="OperChat" commands="WALLOPS CHATOPS">
 117 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME">
 118
 119
 120 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
 121 #                                                                     #
 122 #   This is where you specify which types of operators you have on    #
 123 #   your server, as well as the commands they are allowed to use.     #
 124 #   This works alongside with the classes specified above.            #
 125 #                                                                     #
 126 #  type name  - a name for the combined class types                   #
 127 #  classes    - specified above, used for flexibility for the         #
 128 #               server admin to decide on which operators get         #
 129 #               what commands                                         #
 130 #  host       - hostmask operators will recieve on oper-up            #
 131 #                                                                     #
 132 #  Syntax is as follows:                                              #
 133 #       <type name="name" classes="class name" host="oper hostmask">  #
 134 #                                                                     #
 135
 136 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
 137 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
 138 <type name="LocalOp" classes="OperChat BanControl HostCloak" host="local.omega.org.za">
 139 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
 140
 141
 142 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 143 #                                                                     #
 144 #   Opers are defined here. This is a very important section.         #
 145 #   Remember to only make operators out of truthworthy people.        #
 146 #                                                                     #
 147 #  name      - oper name, best to use lower-case                      #
 148 #  password  - password to oper-up,                                   #
 149 #              encryption not yet available                           #
 150 #  host      - host of client allowed to oper-up, more hostmasks      #
 151 #              seperated by spaces, wildcards accepted                #
 152 #  type      - specified above, defines the kind of operator          #
 153 #                                                                     #
 154 #  Syntax is as follows:                                              #
 155 #       <oper name="login"                                            #
 156 #             password="pass"                                         #
 157 #             host="hostmask@of.oper"                                 #
 158 #             type="oper type">                                       #
 159 #                                                                     #
 160
 161 <oper   name="cc"
 162         password="s3cret"
 163         host="*@*"
 164         type="NetAdmin">
 165
 166
 167 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION   -#-#-#-#-#-#-#-#-#-
 168 #                                                                     #
 169 #   These options let you define the path to your motd and rules      #
 170 #   files.                                                            #
 171 #                                                                     #
 172
 173 <files  motd="/home/cc/inspircd-1.0/conf/inspire.motd"
 174         rules="/home/cc/inspircd-1.0/conf/inspire.rules">
 175
 176
 177
 178 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 179 #                                                                     #
 180 #   Just remove this... Its here to make you read ALL of the config   #
 181 #   file options ;)                                                   #
 182
 183 <die value="And god came down from the heavens and smote down the noob.">
 184
 185
 186
 187 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 188 #                                                                     #
 189 #   Settings to define which features are useable on your server.     #
 190 #                                                                     #
 191 #  prefixquit   - a prefix for a client's quit message                #
 192 #  debug        - provides an in-depth log file,                      #
 193 #                 this should not need to be enabled                  #
 194 #  allowhalfop  - allows the +h channel mode                          #
 195 #  allowprotect - allows the +a channel mode                          #
 196 #  allowfounder - allows the +q channel mode                          #
 197 #                                                                     #
 198
 199 <options prefixquit="Quit: "
 200          debug="off"
 201          allowhalfop="yes"
 202          allowprotect="yes"
 203          allowfounder="yes">
 204
 205
 206
 207 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 208 #                                                                     #
 209 #  These tags define which modules will be loaded on startup by your  #
 210 #  server. Add modules without any paths. When you make your ircd     #
 211 #  using the 'make' command, all compiled modules will be moved into  #
 212 #  the folder you specified when you ran ./configure. The module tag  #
 213 #  automatically looks for modules in this location.                  #
 214
 215 <module name="m_foobar.so">
 216
 217
 218
 219 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 220 #                                                                     #
 221 #   You should already know what to do here :)                        #
 222
 223 <die value="All l33t noobs must edit their configs.">
 224
 225
 226 #########################################################################
 227 #                                                                       #
 228 #                -InspIRCd Development and Coding Team-                 #
 229 #                          www.inspircd.org                             #
 230 #                                                                       #
 231 #########################################################################