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 #  type         - can be 'clients' or 'servers'. The clients type is  #
  59 #                 a standard tcp based socket, the servers type is a  #
  60 #                 UDP based connection.                               #
  61 #  default      - if the port type is 'servers' then this can be      #
  62 #                 specified. If set to 'yes', it indicates that this  #
  63 #                 port is the default route for all /connect commands.#
  64 #                 if you do not bind your default route to an         #
  65 #                 external ip, or all ip's, you may have connection   #
  66 #                 problems.                                           #
  67 #                                                                     #
  68 #  Leaving address empty binds to all available interfaces            #
  69 #                                                                     #
  70 #  Syntax is as follows:                                              #
  71 #                                                                     #
  72 # <bind address="ip number" port="port" type="clients">               #
  73 # <bind address="ip number" port="port" type="servers">               #
  74 # <bind address="ip number" port="port" type="servers" default="yes"> #
  75 #                                                                     #
  76
  77 <bind address="" port="6660" type="clients">
  78 <bind address="" port="7000" type="servers" default="yes">
  79 <bind address="" port="7001" type="servers">
  80
  81
  82 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
  83 #                                                                     #
  84 #   You can configure the passwords here which you wish to use for    #
  85 #   the die and restart commands. Only trusted ircops who will        #
  86 #   need this ability should know the die and restart password.       #
  87 #                                                                     #
  88 #  Syntax is as follows:                                              #
  89 #       <power diepass="die password" restartpass="restart password"  #
  90 #        pause="secs before dying">                                   #
  91 #                                                                     #
  92
  93 <power diepass="diepass" restartpass="restartpass" pause="2">
  94
  95
  96 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
  97 #                                                                     #
  98 #   This is where you can configure which connections are allowed     #
  99 #   and denied access onto your server.                               #
 100 #   The password is optional.                                         #
 101 #   You may have as many of these as you require.                     #
 102 #   To allow/deny all connections use a *                             #
 103 #                                                                     #
 104 #  Syntax is as follows:                                              #
 105 #       <connect allow="ip number">                                   #
 106 #       <connect allow="ip number" password="blahblah">               #
 107 #       <connect allow="ip number" password="blah" timeout="10">      #
 108 #       <connect deny="ip number">                                    #
 109 #                                                                     #
 110 #   You may optionally include timeout="x" on any alllow line, which  #
 111 #   specifies the amount of time given before an unknown connection   #
 112 #   is closed if USER/NICK/PASS are not given. This value is in secs  #
 113 #                                                                     #
 114
 115 <connect allow="196.12.*"  password="tiffany">
 116 <connect allow="*" timeout="60">
 117
 118 <connect deny="69.254.*">
 119
 120
 121 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
 122 #                                                                     #
 123 #   Classes are a group of commands which are grouped together        #
 124 #   and given a unique name. They used to define which commands       #
 125 #   are available to certain types of Operators.                      #
 126 #                                                                     #
 127 #  Syntax is as follow:                                               #
 128 #       <class name="name" commands="oper commands">                  #
 129 #                                                                     #
 130
 131 <class name="Shutdown" commands="DIE RESTART REHASH">
 132 <class name="ServerLink" commands="CONNECT SQUIT">
 133 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE SHUN">
 134 <class name="OperChat" commands="WALLOPS CHATOPS">
 135 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME">
 136
 137
 138 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
 139 #                                                                     #
 140 #   This is where you specify which types of operators you have on    #
 141 #   your server, as well as the commands they are allowed to use.     #
 142 #   This works alongside with the classes specified above.            #
 143 #                                                                     #
 144 #  type name  - a name for the combined class types                   #
 145 #  classes    - specified above, used for flexibility for the         #
 146 #               server admin to decide on which operators get         #
 147 #               what commands                                         #
 148 #  host       - hostmask operators will recieve on oper-up            #
 149 #                                                                     #
 150 #  Syntax is as follows:                                              #
 151 #       <type name="name" classes="class name" host="oper hostmask">  #
 152 #                                                                     #
 153
 154 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
 155 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
 156 <type name="LocalOp" classes="OperChat BanControl HostCloak" host="local.omega.org.za">
 157 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
 158
 159
 160 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
 161 #                                                                     #
 162 #   Opers are defined here. This is a very important section.         #
 163 #   Remember to only make operators out of truthworthy people.        #
 164 #                                                                     #
 165 #  name      - oper name, best to use lower-case                      #
 166 #  password  - password to oper-up,                                   #
 167 #              encryption not yet available                           #
 168 #  host      - host of client allowed to oper-up, more hostmasks      #
 169 #              seperated by spaces, wildcards accepted                #
 170 #  type      - specified above, defines the kind of operator          #
 171 #                                                                     #
 172 #  Syntax is as follows:                                              #
 173 #       <oper name="login"                                            #
 174 #             password="pass"                                         #
 175 #             host="hostmask@of.oper"                                 #
 176 #             type="oper type">                                       #
 177 #                                                                     #
 178
 179 <oper   name="cc"
 180         password="s3cret"
 181         host="*@*"
 182         type="NetAdmin">
 183
 184
 185 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 186 #                                                                     #
 187 # Defines which servers can link to this one, and which servers this  #
 188 # server may create outbound links to.                                #
 189 #                                                                     #
 190 # name      - The name is the canocial name of the server, it does    #
 191 #             not have to resolve - but it is expected to be sent in  #
 192 #             the remote servers connection info.                     #
 193 # ipaddr    - Valid ip address for remote server.                     #
 194 # port      - Valid listening UDP port for remote server.             #
 195 # sendpass  - Password to send to create an outbound connection to    #
 196 #             this server.                                            #
 197 # recvpass  - Password to receive to accept an inbound connection     #
 198 #             from this server.                                       #
 199 #                                                                     #
 200
 201 <link name="hub.penguin.org"
 202         ipaddr="12.34.56.78"
 203         port="7000"
 204         sendpass="outgoing!password"
 205         recvpass="incoming!password">
 206
 207
 208
 209 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
 210 #                                                                     #
 211 #   These options let you define the path to your motd and rules      #
 212 #   files.                                                            #
 213 #                                                                     #
 214
 215 <files  motd="/home/cc/inspircd-1.0/conf/inspire.motd"
 216         rules="/home/cc/inspircd-1.0/conf/inspire.rules">
 217
 218
 219
 220 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
 221 #                                                                     #
 222 #   Just remove this... Its here to make you read ALL of the config   #
 223 #   file options ;)                                                   #
 224
 225 <die value="And god came down from the heavens and smote down the noob.">
 226
 227
 228
 229 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 230 #                                                                     #
 231 #   Settings to define which features are useable on your server.     #
 232 #                                                                     #
 233 #  prefixquit   - a prefix for a client's quit message                #
 234 #  loglevel     - specifies what detail of messages to log in the     #
 235 #                 log file. You may select from debug, verbose,       #
 236 #                 default, sparse and none.                           #
 237 #  allowhalfop  - allows the +h channel mode                          #
 238 #  allowprotect - allows the +a channel mode                          #
 239 #  allowfounder - allows the +q channel mode                          #
 240 #                                                                     #
 241
 242 <options prefixquit="Quit: "
 243          loglevel="default"
 244          allowhalfop="yes"
 245          allowprotect="yes"
 246          allowfounder="yes">
 247
 248
 249
 250 #-#-#-#-#-#-#-#-#-#-#-#-#-  MODULE OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
 251 #                                                                     #
 252 #  These tags define which modules will be loaded on startup by your  #
 253 #  server. Add modules without any paths. When you make your ircd     #
 254 #  using the 'make' command, all compiled modules will be moved into  #
 255 #  the folder you specified when you ran ./configure. The module tag  #
 256 #  automatically looks for modules in this location.                  #
 257
 258 <module name="m_foobar.so">
 259
 260
 261
 262 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
 263 #                                                                     #
 264 #   You should already know what to do here :)                        #
 265
 266 <die value="All l33t noobs must edit their configs.">
 267
 268
 269 #########################################################################
 270 #                                                                       #
 271 #                -InspIRCd Development and Coding Team-                 #
 272 #                          www.inspircd.org                             #
 273 #                                                                       #
 274 #########################################################################