]> git.netwichtig.de Git - user/henk/code/inspircd.git/blob - conf/inspircd.conf.example
fa32053d93b81cb63836fd1e4ad432e2ec50fcab
[user/henk/code/inspircd.git] / conf / inspircd.conf.example
1 ########################################################################
2 #                                                                      #
3 #               ___                ___ ____   ____    _                #
4 #              |_ _|_ __  ___ _ __|_ _|  _ \ / ___|__| |               #
5 #               | || '_ \/ __| '_ \| || |_) | |   / _` |               #
6 #               | || | | \__ \ |_) | ||  _ <| |__| (_| |               #
7 #              |___|_| |_|___/ .__/___|_| \_\\____\__,_|               #
8 #                            |_|                                       #
9 #      ____             __ _                       _   _               #
10 #     / ___|___  _ __  / _(_) __ _ _   _ _ __ __ _| |_(_) ___  _ __    #
11 #    | |   / _ \| '_ \| |_| |/ _` | | | | '__/ _` | __| |/ _ \| '_ \   #
12 #    | |__| (_) | | | |  _| | (_| | |_| | | | (_| | |_| | (_) | | | |  #
13 #     \____\___/|_| |_|_| |_|\__, |\__,_|_|  \__,_|\__|_|\___/|_| |_|  #
14 #                            |___/                                     #
15 #                                                                      #
16 ##################################||####################################
17                                  #||#                                   
18 ##################################||####################################
19 #                                                                      #
20 #         This is an example of the config file for InspIRCd.          #
21 #             Change the options to suit your network                  #
22 #                                                                      #
23 #     $Id$     #
24 #                                                                      #
25 #    ____                _   _____ _     _       ____  _ _   _         #
26 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |        #
27 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |        #
28 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|        #
29 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)        #
30 #                                                                      #
31 #   Lines prefixed with READ THIS BIT, as shown above, are IMPORTANT   #
32 #   lines, and you REALLY SHOULD READ THEM. Yes, THIS MEANS YOU. Even  #
33 #   if you've configured InspIRCd before, these probably indicate      #
34 #   something new or different to this version and you SHOULD READ IT. #
35 #                                                                      #
36 ########################################################################
37 #                                                                      #
38 #         Unalphabeticalise the modules list at your own risk          #
39 #                                                                      #
40 ########################################################################
41
42
43 #-#-#-#-#-#-#-#-#-#-#-#-  SERVER DESCRIPTION  -#-#-#-#-#-#-#-#-#-#-#-#-
44 #                                                                     #
45 #   Here is where you enter the information about your server.        #
46 #                                                                     #
47 #  Syntax is as follows:                                              #
48 #                                                                     #
49 #     <server name="server.name"                                      #
50 #      description="Server Description"                               #
51 #      id="serverid"                                                  #
52 #      network="MyNetwork">                                           #
53 #                                                                     #
54 #  The server name should be a syntactically valid hostname, with at  #
55 #  least one '.', and does not need to resolve to an IP address.      #
56 #                                                                     #
57 #  The description is freeform text. Remember you may put quotes in   #
58 #  this field by escaping it using \".                                #
59 #                                                                     #
60 #  The network field indicates the network name given in on connect   #
61 #  to clients. It is used by many clients such as mIRC to select a    #
62 #  perform list, so it should be identical on all servers on a net    #
63 #  and should not contain spaces.                                     #
64 #                                                                     #
65 #  The server ID is optional, and if omitted automatically calculated # 
66 #  from the server name and description. This is similar in           #
67 #  in behaviour to the server id on ircu and charybdis ircds.         #
68 #  You should only need to set this manually if there is a collision  #
69 #  between two server ID's on the network. The server ID must be      #
70 #  three digits or letters long, of which the first digit must always #
71 #  be a number, and the other two letters may be any of 0-9 and A-Z.  #
72 #  For example, 3F9, 03J and 666 are all valid server IDs, and A9D,   #
73 #  QFX and 5eR are not. Remember, in most cases you will not need to  #
74 #  even set this value, it is calculated for you from your server     #
75 #  name and description. Changing these will change your auto-        #
76 #  generated ID.                                                      #
77 #                                                                     #
78
79 <server name="penguin.omega.org.za"
80         description="Waddle World"
81         network="Omega">
82
83
84 #-#-#-#-#-#-#-#-#-#-#-#-   ADMIN INFORMATION   -#-#-#-#-#-#-#-#-#-#-#-#
85 #                                                                     #
86 #   Describes the Server Administrator's real name (optionally),      #
87 #   nick, and email address.                                          #
88 #                                                                     #
89 #  Syntax is as follows:                                              #
90 #       <admin name="real name"                                       #
91 #              nick="nick name"                                       #
92 #              email="email@address.com">                             #
93 #                                                                     #
94
95 <admin name="Johnny English"
96        nick="MI5"
97        email="MI5@the.best.secret.agent">
98
99
100 #-#-#-#-#-#-#-#-#-#-#-#-   PORT CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
101 #                                                                     #
102 #   Enter the port and address bindings here.                         #
103 #                                                                     #
104 #  bind address - Specifies which address ports bind to. Leaving this #
105 #                 field blank binds the port to all IP's available.   #
106 #                                                                     #
107 #  port         - The port number to bind to. You may specify a port  #
108 #                 range here, e.g. "6667-6669,7000,7001". If you do   #
109 #                 this, the server will count each port within your   #
110 #                 range as a separate binding, making the above       #
111 #                 example equivalent to five separate bind tags.      #
112 #                 A failure on one port in the range does not prevent #
113 #                 the entire range from being bound, just that one    #
114 #                 port number.                                        #
115 #                                                                     #
116 #  type         - Can be 'clients' or 'servers'. The clients type is  #
117 #                 a standard TCP based socket, the servers type is a  #
118 #                 also a TCP based connection but of a different      #
119 #                 format. SSL support is provided by modules, to      #
120 #                 enable SSL support, please read the module section  #
121 #                 of this configuration file.                         #
122 #                                                                     #
123 #  ssl          - When using m_ssl_gnutls.so or m_ssl_openssl.so      #
124 #                 modules, you must define this value to use ssl on   #
125 #                 that port. Valid values are 'gnutls' or 'openssl'   #
126 #                 respectively. If the module is not loaded, this     #
127 #                 setting is ignored.                                 #
128 #                                                                     #
129 #  transport    - If you have m_spanningtree.so loaded, along with    #
130 #                 either one of the SSL modules (m_ssl_gnutls or      #
131 #                 m_ssl_openssl) or m_ziplinks.so, then you may make  #
132 #                 use of this value.                                  #
133 #                 Setting it to 'openssl' or 'gnutls' or 'zip'        #
134 #                 indicates that the port should accept connections   #
135 #                 using the given transport name. Transports are      #
136 #                 layers which sit on top of a socket and change the  #
137 #                 way data is sent and received, e.g. encryption,     #
138 #                 compression, and other such things. Because this    #
139 #                 may not be limited in use to just encryption,       #
140 #                 the 'ssl' value used for client ports does not      #
141 #                 exist for servers, and this value is used instead.  #
142 #    ____                _   _____ _     _       ____  _ _   _        #
143 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
144 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
145 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
146 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
147 #                                                                     #
148 #  If you want to link servers to InspIRCd you must load the          #
149 #  m_spanningtree.so module! Please see the modules list below for    #
150 #  information on how to load this module! If you do not load this    #
151 #  module, server ports will NOT be bound!                            #
152 #                                                                     #
153 #  Leaving address empty binds to all available interfaces            #
154 #                                                                     #
155 #  Syntax is as follows:                                              #
156 #                                                                     #
157 # <bind address="ip address" port="port" type="clients">              #
158 # <bind address="ip address" port="port" type="servers">              #
159 #                                                                     #
160 # If InspIRCd is built for IPv6, and you wish to accept IPv4 clients, #
161 # then you can specify IPv4 ip addresses here to bind. You may also   #
162 # use the 4in6 notation, ::ffff:1.2.3.4, where 1.2.3.4 is the IPv4    #
163 # address to bind the port, but as of InspIRCd 1.1.1, this is not     #
164 # required.                                                           #
165 #                                                                     #
166 # ------------------------------------------------------------------- #
167 #                                                                     #
168 # PLEASE NOTE: If you have build InspIRCd as an IPv6 server, and you  #
169 # specify an empty bind address, the binding will be bound to ALL THE #
170 # IPv6 IP ADDRESSES, and not the IPv4 addresses. If you are using an  #
171 # IPv6 enabled InspIRCd and want to bind to multiple IPv4 addresses   #
172 # in this way, you must specify them by hand. If you have built the   #
173 # server for IPv4 connections only, then specifying an empty bind     #
174 # address binds the port to all IPv4 IP addresses, as expected.       #
175 #                                                                     #
176
177 <bind address="" port="6000" type="clients">
178 <bind address="" port="6660-6669" type="clients" ssl="gnutls">
179
180 # When linking servers, the openssl and gnutls transports are largely
181 # link-compatible and can be used alongside each other or either/or
182 # on each end of the link without any significant issues.
183
184 <bind address="" port="7000,7001" type="servers">
185 <bind address="1.2.3.4" port="7005" type="servers" transport="openssl">
186
187
188 #-#-#-#-#-#-#-#-#-#-  DIE/RESTART CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-
189 #                                                                     #
190 #   You can configure the passwords here which you wish to use for    #
191 #   the die and restart commands. Only trusted IRCop's who will       #
192 #   need this ability should know the die and restart password.       #
193 #                                                                     #
194 #  Syntax is as follows:                                              #
195 #       <power diepass="die password" restartpass="restart password"  #
196 #        pause="secs before dying">                                   #
197 #                                                                     #
198
199 <power diepass="" restartpass="" pause="2">
200
201
202 #-#-#-#-#-#-#-#-#-#  INCLUDE CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#-#-#
203 #                                                                     #
204 # This optional tag allows you to include another config file         #
205 # allowing you to keep your configuration tidy. The configuration     #
206 # file you include will be treated as part of the configuration file  #
207 # which includes it, in simple terms the inclusion is transparent.    #
208 #                                                                     #
209 # All paths to config files are relative to the directory of the main #
210 # config file inspircd.conf, unless the filename starts with a forward#
211 # slash (/) in which case it is treated as an absolute path.          #
212 #                                                                     #
213 # You may also include an executable file, in which case if you do so #
214 # the output of the executable on the standard output will be added   #
215 # to your config at the point of the include tag.                     #
216 #                                                                     #
217 # Syntax is as follows:                                               #
218 #<include file="file.conf">                                           #
219 #<include executable="/path/to/executable parameters">                #
220 #                                                                     #
221
222 #-#-#-#-#-#-#-#-#-#-  CONNECTIONS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#-#
223 #                                                                     #
224 #   This is where you can configure which connections are allowed     #
225 #   and denied access onto your server. The password is optional.     #
226 #   You may have as many of these as you require. To allow/deny all   #
227 #   connections, use a '*' or 0.0.0.0/0.                              #
228 #                                                                     #
229 #  Syntax is as follows:                                              #
230 #                                                                     #
231 #       <connect name="myallow" allow="1.2.3.0/24" limit="5"          #
232 #                password="blahblah" timeout="10" timeout="blah"      #
233 #                flood="5" threshold="8" pingfreq="120" sendq="99999" #
234 #                revcq="696969" localmax="3" globalmax="3"            #
235 #                port="6660" maxchans="50" limit="999">               #
236 #                                                                     #
237 #       <connect name="blocked" deny="127.0.0.1" port="6667">         #
238 #                                                                     #
239 #       <connect name="something" parent="myallow" pingfreq="60">     #
240 #                                                                     #
241 #   IP masks may be specified in CIDR format or wildcard format,      #
242 #   for IPv4 and IPv6. You *cannot* use hostnames in the allow or     #
243 #   deny field, as the state is applied before the user's DNS has     #
244 #   been resolved.                                                    #
245 #                                                                     #
246 #   You can optionally name your connect allow/deny tags. If you do   #
247 #   this, you may reference this connect tag as the parent of another #
248 #   connect tag with the <connect:parent> option as shown above. If   #
249 #   you do this, any options not explicitly specified in the tag will #
250 #   be copied from the parent.                                        #
251 #                                                                     #
252 #   If the value maxchans is included, this overrides all other max   #
253 #   channels related settings, including the separate oper maximum.   #
254 #   You may set this to any (sane) value you wish and it applies to   #
255 #   all users within this connect tag.                                #
256 #                                                                     #
257 #   You may optionally include timeout="x" on any allow line, which   #
258 #   specifies the amount of time given before an unknown connection   #
259 #   is closed if USER/NICK/PASS are not given. This value is in secs. #
260 #                                                                     #
261 #   You may optionally limit the number of clients that are matched   #
262 #   by a single <connect> tag by specifying the maximum in the limit  #
263 #   parameter. If set to 0, there is no limit, which is the default.  #
264 #                                                                     #
265 #   You should also include a flood="x" line which indicates          #
266 #   the number of lines a user may place into their buffer at once    #
267 #   before they are disconnected for excess flood. This feature can   #
268 #   not be disabled, however it can be set to extremely high values,  #
269 #   rendering it effectively disabled. A recommended value is 10.     #
270 #   A counter is maintained for each user which is reset every        #
271 #   'threshold' seconds and specifying this threshold value with      #
272 #   threshold="X" indicates how often the counter is reset. For       #
273 #   example, with flood="5" and threshold="8", the user may not send  #
274 #   more than 5 lines in 8 secs.                                      #
275 #                                                                     #
276 #   You may optionally specify the sendq size and ping frequency of   #
277 #   each connect:allow line using the pingfreq="X" and sendq="X"      #
278 #   settings as shown in the full example below.                      #
279 #   The ping frequency is specified in seconds, and the sendq size    #
280 #   in bytes. It is recommended, although not enforced, that you      #
281 #   should never set your sendq size to less than 8K. Send Queues are #
282 #   dynamically allocated and can grow as needed up to the maximum    #
283 #   size specified.                                                   #
284 #                                                                     #
285 #   The optional recvq value is the maximum size which users in this  #
286 #   group may grow their receive queue to. This is recommended to be  #
287 #   kept pretty low compared to the sendq, as users will always       #
288 #   receive more than they send in normal circumstances. The default  #
289 #   if not specified is 4096.                                         #
290 #                                                                     #
291 #   The sendq is the data waiting to be sent TO THE USER.             #
292 #   The recvq is the data being received FROM THE USER.               #
293 #   The names sendq and recvq are from the SERVER'S PERSPECTIVE not   #
294 #   that of the user... Just to clear up any confusion or complaints  #
295 #   that these are backwards :p                                       #
296 #                                                                     #
297 #   The localmax and globalmax values can be used to enforce local    #
298 #   and global session limits on connections. The session limits are  #
299 #   counted against all users, but applied only to users within the   #
300 #   class. For example, if you had a class 'A' which has a session    #
301 #   limit of 3, and a class 'B' which has a session limit of 5, and   #
302 #   somehow, two users managed to get into class B which also match   #
303 #   class A, there is only one connection left for this IP now in A,  #
304 #   but if they can connect again to B, there are three. You get the  #
305 #   idea (i hope).                                                    #
306 #                                                                     #
307 #   The optional port value determines which port the connect tag is  #
308 #   handling. If left out the connect tag covers all bound ports else #
309 #   only incoming connections on the specified port will match. Port  #
310 #   tags may be used on connect allow and connect deny tags.          #
311 #                                                                     #
312 #   The limit value determines the maximum number of users which may  #
313 #   be in this class. Combine this with CIDR masks for various ISP    #
314 #   subnets to limit the number of users which may connect at any one #
315 #   time from a certain ISP. Omit this value to not limit the tag.    #
316 #                                                                     #
317
318 <connect allow="196.12.*"  password="secret" port="6667">
319
320 <connect allow="*"
321          timeout="60"
322          flood="20"
323          threshold="1"
324          pingfreq="120"
325          sendq="262144"
326          recvq="8192"
327          localmax="3"
328          globalmax="3"
329          limit="5000">
330
331 <connect deny="69.254.*">
332 <connect deny="3ffe::0/32">
333
334
335 #-#-#-#-#-#-#-#-#-#-#-#-  CLASS CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#-
336 #                                                                     #
337 #   Classes are a group of commands which are grouped together and    #
338 #   given a unique name. They're used to define which commands        #
339 #   are available to certain types of Operators.                      #
340 #                                                                     #
341 #  Syntax is as follows:                                              #
342 #                                                                     #
343 #       <class name="name" commands="oper commands"                   #
344 #       usermodes="allowed oper only usermodes"                       #
345 #       chanmodes="allowed oper only channelmodes">                   #
346 #                                                                     #
347 # The name value indicates a name for this class.                     #
348 # The commands value indicates a list of one or more commands that    #
349 # are allowed by this class (see also 'READ THIS BIT' below).         #
350 # The usermodes and chanmodes values indicate lists of usermodes and  #
351 # channel modes this oper can execute. This only applies to modes     #
352 # that are marked oper-only such as usermode +Q and channelmode +O.   #
353 #    ____                _   _____ _     _       ____  _ _   _        #
354 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
355 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
356 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
357 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
358 #                                                                     #
359 #  You are not forced to give these classes the names given below.    #
360 #  You can create your own named classes, if you want, in fact that   #
361 #  is the whole idea of this system!                                  #
362 #                                                                     #
363 #  Note: It is possible to make a class which covers all available    #
364 #  commands. To do this, specify commands="*". This is not really     #
365 #  recommended, as it negates the whole purpose of the class system,  #
366 #  however it is provided for fast configuration (e.g. in test nets)  #
367 #                                                                     #
368
369 <class name="Shutdown" commands="DIE RESTART REHASH LOADMODULE UNLOADMODULE RELOAD" usermodes="*" chanmodes="*">
370 <class name="ServerLink" commands="CONNECT SQUIT RCONNECT MKPASSWD MKSHA256" usermodes="*" chanmodes="*">
371 <class name="BanControl" commands="KILL GLINE KLINE ZLINE QLINE ELINE" usermodes="*" chanmodes="*">
372 <class name="OperChat" commands="WALLOPS GLOBOPS SETIDLE SPYLIST SPYNAMES" usermodes="*" chanmodes="*">
373 <class name="HostCloak" commands="SETHOST SETIDENT SETNAME CHGHOST CHGIDENT" usermodes="*" chanmodes="*">
374
375
376 #-#-#-#-#-#-#-#-#-#-#-#-  OPERATOR COMPOSITION   -#-#-#-#-#-#-#-#-#-#-#
377 #                                                                     #
378 #   This is where you specify which types of operators you have on    #
379 #   your server, as well as the commands they are allowed to use.     #
380 #   This works alongside with the classes specified above.            #
381 #                                                                     #
382 #  type name  - A name for the combined class types.                  #
383 #               a type name cannot contain spaces, however if you     #
384 #               put an _ symbol in the name, it will be translated    #
385 #               to a space when displayed in a WHOIS.                 #
386 #                                                                     #
387 #  classes    - Specified above, used for flexibility for the         #
388 #               server admin to decide on which operators get         #
389 #               what commands. Class names are case sensitive,        #
390 #               separate multiple class names with spaces.            #
391 #                                                                     #
392 #  host       - Optional hostmask operators will receive on oper-up.  #
393 #                                                                     #
394 #  Syntax is as follows:                                              #
395 #                                                                     #
396 #     <type name="name" classes="class names" host="oper hostmask">   #
397 #                                                                     #
398 #    ____                _   _____ _     _       ____  _ _   _        #
399 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
400 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
401 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
402 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
403 #                                                                     #
404 #  You are not forced to give these types the names given below.      #
405 #  You can create your own named types, if you want, in fact that     #
406 #  is the whole idea of this system!                                  #
407 #                                                                     #
408
409 <type name="NetAdmin" classes="OperChat BanControl HostCloak Shutdown ServerLink" host="netadmin.omega.org.za">
410 <type name="GlobalOp" classes="OperChat BanControl HostCloak ServerLink" host="ircop.omega.org.za">
411 <type name="Helper" classes="HostCloak" host="helper.omega.org.za">
412
413
414 #-#-#-#-#-#-#-#-#-#-#-  OPERATOR CONFIGURATION   -#-#-#-#-#-#-#-#-#-#-#
415 #                                                                     #
416 #   Opers are defined here. This is a very important section.         #
417 #   Remember to only make operators out of trust worthy people.       #
418 #                                                                     #
419 #  name        - Oper name, this is case sensitive, so it is best to  #
420 #                use lower-case.                                      #
421 #                                                                     #
422 #  password    - Password to oper-up, also case sensitive.            #
423 #                encryption is supported via modules. You may load    #
424 #                modules for MD5 or SHA256 encryption, and if you do, #
425 #                this value will be a hash value, otherwise put a     #
426 #                plaintext password in this value.                    #
427 #                                                                     #
428 #  host        - Hosts of client allowed to oper-up.                  #
429 #                wildcards accepted, separate multiple hosts with a   #
430 #                space. You may also specify CIDR IP addresses.       #
431 #                                                                     #
432 #  fingerprint - When using the m_ssl_oper_cert.so module, you may    #
433 #                specify a key fingerprint here. This can be obtained #
434 #                using the /fingerprint command whilst the module is  #
435 #                loaded, or from the notice given to you when you     #
436 #                connect to the ircd using a client certificate,      #
437 #                and will lock this oper block to only the user who   #
438 #                has that specific key/certificate pair.              #
439 #                this enhances security a great deal, however it      #
440 #                requires that opers use clients which can send ssl   #
441 #                client certificates, if this is configured for that  #
442 #                oper. Note that if the m_ssl_oper.so module is not   #
443 #                loaded, and/or one of m_ssl_openssl or m_ssl_gnutls  #
444 #                is not loaded, this configuration option has no      #
445 #                effect and will be ignored.                          #
446 #                                                                     #
447 #  type        - Defines the kind of operator. This must match a type #
448 #                tag you defined above, and is case sensitive.        #
449 #                                                                     #
450 #  Syntax is as follows:                                              #
451 #       <oper name="login"                                            #
452 #             password="pass"                                         #
453 #             host="hostmask@of.oper"                                 #
454 #             fingerprint="hexsequence"                               #
455 #             type="oper type">                                       #
456 #                                                                     #
457
458 <oper name="Brain"
459       password="s3cret"
460       host="ident@dialup15.isp.com *@localhost *@server.com *@3ffe::0/16"
461       type="NetAdmin">
462
463
464 #-#-#-#-#-#-#-#-#-#-#-  SERVER LINK CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
465 #                                                                     #
466 # Defines which servers can link to this one, and which servers this  #
467 # server may create outbound links to.                                #
468 #                                                                     #
469 # name        -   The name is the canonical name of the server, does   #
470 #                 not have to resolve - but it is expected to be set  #
471 #                 in the remote servers connection info.              #
472 #                                                                     #
473 # ipaddr      -   Valid host or IP address for remote server. These   #
474 #                 hosts are resolved on rehash, and cached, if you    #
475 #                 specify a hostname; so if you find that your server #
476 #                 is still trying to connect to an old IP after you   #
477 #                 have updated your DNS, try rehashing and then       #
478 #                 attempting the connect again.                       #
479 #                                                                     #
480 # port        -   The TCP port for the remote server.                 #
481 #                                                                     #
482 # sendpass    -   Password to send to create an outbound connection   #
483 #                 to this server.                                     #
484 #                                                                     #
485 # recvpass    -   Password to receive to accept an inbound connection #
486 #                 from this server.                                   #
487 #                                                                     #
488 # autoconnect -   Sets the server to autoconnect. Where x is the num. #
489 # (optional)      of seconds between attempts. e.g. 300 = 5 minutes.  #
490 #                                                                     #
491 # transport     - If defined, this is a transport name implemented by #
492 #                 another module. Transports are layers on top of     #
493 #                 plaintext connections, which alter them in certain  #
494 #                 ways. Currently the three supported transports are  #
495 #                 'openssl' and 'gnutls' which are types of SSL       #
496 #                 encryption, and 'zip' which is for compression.     #
497 #                 If you define a transport, both ends of the         #
498 #                 connection must use a compatible transport for the  #
499 #                 link to succeed. OpenSSL and GnuTLS are link-       #
500 #                 compatible with each other.                         #
501 #                                                                     #
502 # statshidden   - When using m_spanningtree.so for linking. you may   #
503 #                 set this to 'yes', and if you do, the IP address/   #
504 #                 hostname of this connection will NEVER be shown to  #
505 #                 any opers on the network. In /stats c its address   #
506 #                 will show as *@<hidden>, and during CONNECT and     #
507 #                 inbound connections, it's IP will show as <hidden>  #
508 #                 UNLESS the connection fails (e.g. due to a bad      #
509 #                 password or servername)                             #
510 #                                                                     #
511 # allowmask     - When this is defined, it indicates a range of IP    #
512 #                 addresses to allow for this link (You may use CIDR  #
513 #                 or wildcard form for this address).                 #
514 #                 e.g. if your server is going to connect to you from #
515 #                 the range 1.2.3.1 through 1.2.3.255, put 1.2.3.0/24 #
516 #                 into this value. If it is not defined, then only    #
517 #                 the ipaddr field of the server shall be allowed.    #
518 #                                                                     #
519 # failover      - If you define this option, it must be the name of a #
520 #                 different link tag in your configuration. This      #
521 #                 option causes the ircd to attempt a connection to   #
522 #                 the failover link in the event that the connection  #
523 #                 to this server fails. For example, you could define #
524 #                 two hub uplinks to a leaf server, and set an        #
525 #                 american server to autoconnect, with a european     #
526 #                 hub as its failover. In this situation, your ircd   #
527 #                 will only try the link to the european hub if the   #
528 #                 american hub is unreachable. NOTE that for the      #
529 #                 intents and purposes of this option, an unreachable #
530 #                 server is one which DOES NOT ANSWER THE CONNECTION. #
531 #                 If the server answers the connection with accept(), #
532 #                 EVEN IF THE CREDENTIALS ARE INVALID, the failover   #
533 #                 link will not be tried! Failover settings will also #
534 #                 apply to autoconnected servers as well as manually  #
535 #                 connected ones.                                     #
536 #                                                                     #
537 # timeout       - If this is defined, then outbound connections will  #
538 #                 time out if they are not connected within this many #
539 #                 seconds. If this is not defined, the default of ten #
540 #                 seconds is used.                                    #
541 #                                                                     #
542 # bind          - If you specify this value, then when creating an    #
543 #                 outbound connection to the given server, the IP you #
544 #                 place here will be bound to. This is for multi-     #
545 #                 homed servers which may have multiple IP addresses. #
546 #                 if you do not define this value, the first IP that  #
547 #                 is not empty or localhost from your <bind> tags     #
548 #                 will be bound to. This is usually acceptable,       #
549 #                 however if your server has multiple network cards   #
550 #                 then you may have to manually specify the bind      #
551 #                 value instead of leaving it to automatic binding.   #
552 #                 you can usually tell if you need to set this by     #
553 #                 looking for the error 'Could not assign requested   #
554 #                 address' in your log when connecting to servers.    #
555 #                                                                     #
556 # hidden        - If this is set to true, yes, or 1, then the server  #
557 #                 is completely hidden from non-opers. It does not    #
558 #                 show in /links and it does not show in /map. Also,  #
559 #                 any servers which are child servers of this one     #
560 #                 in the network will *also* be hidden. Use with      #
561 #                 care! You can use this to 'mask off' sections of    #
562 #                 the network so that users only see a small portion  #
563 #                 of a much larger net. It should NOT be relied upon  #
564 #                 as a security tool, unless it is being used for     #
565 #                 example to hide a non-client hub, for which clients #
566 #                 do not have an IP address or resolvable hostname.   #
567 #                                                                     #
568 # To u:line a server (give it extra privileges required for running   #
569 # services, Q, etc) you must include the <uline server> tag as shown  #
570 # in the example below. You can have as many of these as you like.    #
571 #                                                                     #
572 # WARNING: Unlike other ircds, u:lining a server allows ALL users on  #
573 # that server to operoverride modes. This should only be used for     #
574 # services and protected oper servers!                                #
575 #                                                                     #
576 # ------------------------------------------------------------------- #
577 #                                                                     #
578 # NOTE: If you have built your server as an IPv6 server, then when a  #
579 # DNS lookup of a server's host occurs, AAAA records (IPv6) are       #
580 # prioritised over A records (IPv4). Therefore, if the server you are #
581 # connecting to has both an IPv6 IP address and an IPv4 IP address in #
582 # its DNS entry, the IPv6 address will *always* be selected. To       #
583 # change this behaviour simply specify the IPv4 IP address rather     #
584 # than the hostname of the server.                                    #
585 #                                                                     #
586 # ------------------------------------------------------------------- #
587 #                                                                     #
588 #    ____                _   _____ _     _       ____  _ _   _        #
589 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
590 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
591 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
592 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
593 #                                                                     #
594 #  If you want to link servers to InspIRCd you must load the          #
595 #  m_spanningtree.so module! Please see the modules list below for    #
596 #  information on how to load this module! If you do not load this    #
597 #  module, server links will NOT work!                                #
598 #                                                                     #
599 #  Also, if you define any transports, you must load the modules for  #
600 #  these transports BEFORE you load m_spanningtree, e.g. place them   #
601 #  above it in the configuration file. Currently this means the three #
602 #  modules m_ssl_gnutls, m_ziplinks and m_ssl_openssl, depending on   #
603 #  which you choose to use.                                           #
604 #                                                                     #
605
606 <link name="hub.penguin.org"
607       ipaddr="penguin.box.com"
608       port="7000"
609       allowmask="69.58.44.0/24"
610       autoconnect="300"
611       failover="hub.other.net"
612       timeout="15"
613       transport="gnutls"
614       bind="1.2.3.4"
615       statshidden="no"
616       hidden="no"
617       sendpass="outgoing!password"
618       recvpass="incoming!password">
619
620 <link name="services.antarctic.com"
621       ipaddr="localhost"
622       port="7000"
623       allowmask="127.0.0.0/8"
624       sendpass="penguins"
625       recvpass="polarbears">
626
627
628 #-#-#-#-#-#-#-#-#-#-#-#- ULINES CONFIGURATION #-#-#-#-#-#-#-#-#-#-#-#-#
629 # This tag defines a ulined server. A U-Lined server has special      #
630 # permissions, and should be used with caution. Services servers are  #
631 # usually u-lined in this manner.                                     #
632 #                                                                     #
633 # The 'silent' value, if set to yes, indicates that this server should#
634 # not generate quit and connect notices, which can cut down on noise  #
635 # to opers on the network.                                            #
636 #                                                                     #
637 <uline server="services.antarctic.com" silent="yes">
638
639
640 #-#-#-#-#-#-#-#-#-#-  MISCELLANEOUS CONFIGURATION  -#-#-#-#-#-#-#-#-#-#
641 #                                                                     #
642 #   These options let you define the path to your motd and rules      #
643 #   files. If these are relative paths, they are relative to the      #
644 #   configuration directory.                                           #
645 #                                                                     #
646
647 <files motd="inspircd.motd.example"
648        rules="inspircd.rules.example">
649
650 #-#-#-#-#-#-#-#-#-#-#-# MAXIMUM CHANNELS -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
651 #                                                                     #
652 # This optional configuration tag lets you define the maximum number  #
653 # of channels that both opers and users may be on at any one time.    #
654 # The default is 20 for users and 60 for opers if this tag is not     #
655 # defined. Remote users are not restricted in any manner.             #
656 #                                                                     #
657
658 <channels users="20"
659           opers="60">
660
661 #-#-#-#-#-#-#-#-#-#-#-#-#-#-# DNS SERVER -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
662 #                                                                     #
663 # Define your DNS server address here. InspIRCd has its own resolver. #
664 # If you do not define this value, then InspIRCd will attempt to      #
665 # determine your DNS server from your operating system. On POSIX      #
666 # platforms, InspIRCd will read /etc/resolv.conf, and populate this   #
667 # value with the first DNS server address found. On Windows platforms #
668 # InspIRCd will check the registry, and use the DNS server of the     #
669 # first active network interface, if one exists.                      #
670 # If a DNS server cannot be determined from these checks, the default #
671 # value '127.0.0.1' is used instead. The timeout value is in seconds. #
672 #                                                                     #
673 #    ____                _   _____ _     _       ____  _ _   _        #
674 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
675 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
676 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
677 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
678 #                                                                     #
679 # When choosing a server, be sure to choose one which will do a       #
680 # RECURSIVE LOOKUP. InspIRCd's resolver does not currently do these   #
681 # recursive lookups itself, to save time and resources. The DNS       #
682 # server recommended by the InspIRCd team is bind, available from the #
683 # ISC website. If your DNS server does not do a recursive lookup, you #
684 # will be able to notice this by the fact that none of your users are #
685 # resolving even though the DNS server appears to be up! Most ISP and #
686 # hosting provider DNS servers support recursive lookups.             #
687 #                                                                     #
688 # ------------------------------------------------------------------- #
689 #                                                                     #
690 # NOTE: If you have built InspIRCd with IPv6 support, then both       #
691 # IPv6 and IPv4 addresses are allowed here, and also in the system    #
692 # resolv.conf file. Remember that an IPv4 DNS server can still        #
693 # resolve IPv6 addresses, and vice versa.                             #
694 #                                                                     #
695
696 <dns server="127.0.0.1" timeout="5">
697
698 # An example of using an IPv6 nameserver
699 #<dns server="::1" timeout="5">
700
701 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#  PID FILE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
702 #                                                                     #
703 # Define the path to the PID file here. The PID file can be used to   #
704 # rehash the ircd from the shell or to terminate the ircd from the    #
705 # shell using shell scripts, perl scripts, etc... and to monitor the  #
706 # ircd's state via cron jobs. If this is a relative path, it will be  #
707 # relative to the configuration directory, and if it is not defined,  #
708 # the default of 'inspircd.pid' is used.                              #
709 #                                                                     #
710
711 #<pid file="/path/to/inspircd.pid">
712
713 #-#-#-#-#-#-#-#-#-#-#-#-#- BANLIST LIMITS #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
714 #                                                                     #
715 # Use these tags to customise the ban limits on a per channel basis.  #
716 # The tags are read from top to bottom, and any tag found which       #
717 # matches the channels name applies the banlimit to that channel.     #
718 # It is advisable to put an entry with the channel as '*' at the      #
719 # bottom of the list. If none are specified or no maxbans tag is      #
720 # matched, the banlist size defaults to 64 entries.                   #
721 #                                                                     #
722
723 <banlist chan="#morons" limit="128">
724 <banlist chan="*" limit="69">
725
726 #-#-#-#-#-#-#-#-#-#-#-  DISABLED COMMANDS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
727 #                                                                     #
728 # This tag is optional, and specifies one or more commands which are  #
729 # not available to non-operators. For example you may wish to disable #
730 # NICK and prevent non-opers from changing their nicknames.           #
731 # Note that any disabled commands take effect only after the user has #
732 # 'registered' (e.g. after the initial USER/NICK/PASS on connection)  #
733 # so for example disabling NICK will not cripple your network.        #
734 #                                                                     #
735
736 #<disabled commands="TOPIC MODE">
737
738
739 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-  RTFM LINE  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
740 #                                                                     #
741 #   Just remove this... Its here to make you read ALL of the config   #
742 #   file options ;)                                                   #
743
744 <die value="You should probably edit your config *PROPERLY* and try again.">
745
746
747
748 #-#-#-#-#-#-#-#-#-#-#-#-#-  SERVER OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
749 #                                                                     #
750 #   Settings to define which features are usable on your server.      #
751 #                                                                     #
752 #  prefixquit    - A prefix to be placed on the start of a client's   #
753 #                  quit message                                       #
754 #                                                                     #
755 #  suffixquit    - A suffix to be placed on the end of a client's     #
756 #                  quit message.                                      #
757 #                                                                     #
758 #  fixedquit     - A fixed quit message to display for all client     #
759 #                  QUITS. If specified, overrides both prefixquit     #
760 #                  and suffixquit options.                            #
761 #                                                                     #
762 #  prefixpart    - A prefix to be placed on the start of a client's   #
763 #                  part message                                       #
764 #                                                                     #
765 #  suffixpart    - A suffix to be placed on the end of a client's     #
766 #                  part message.                                      #
767 #                                                                     #
768 #  fixedpart     - A fixed part message to display for all client     #
769 #                  parts. If specified, overrides both prefixpart     #
770 #                  and suffixpart options.                            #
771 #                                                                     #
772 #  allowhalfop   - Allows the +h channel mode                         #
773 #                                                                     #
774 #  noservices    - If noservices is true, yes, or 1, then the first   #
775 #                  user into a channel gets founder status. This is   #
776 #                  only useful on networks running the m_chanprotect  #
777 #                  module without services.                           #
778 #                                                                     #
779 #  qprefix       - qprefix is used by the chanprotect module to give  #
780 #                  a visible prefix to users set +q (founder) in chan #
781 #                  It should be set to something sensible like ~ or ! #
782 #                  If not set, no prefix is applied to users with +q  #
783 #                                                                     #
784 #  aprefix       - aprefix is the same as qprefix, except it is for   #
785 #                  giving users with mode +a (protected) a prefix     #
786 #                                                                     #
787 #  deprotectself - If this value is set to yes, true, or 1, then any  #
788 #                  user with +q or +a may remove the +q or +a from    #
789 #                  themselves. The default setting is to not enable   #
790 #                  this feature, which stops even the founder taking  #
791 #                  away their founder status without using services.  #
792 #                                                                     #
793 #  deprotectothers-If this value is set to yes, true, or 1, then any  #
794 #                  user with +q or +a may remove the +q or +a from    #
795 #                  other users. The default setting is to not enable  #
796 #                  this feature, so that only +q may remove +a, and   #
797 #                  nothing but services may remove +q.                #
798 #                                                                     #
799 #  cyclehosts    - If this is set to true, yes or 1, then when a      #
800 #                  user's hostname changes, they will appear to quit  #
801 #                  and then rejoin with their new host. This prevents #
802 #                  clients from being confused by host changes,       #
803 #                  especially in the case of bots, and it is          #
804 #                  recommended that this option is enabled.           #
805 #                                                                     #
806 #  moduledir     - This optional value indicates a runtime change of  #
807 #                  the location where modules are to be found. This   #
808 #                  does not add a supplementary directory. There can  #
809 #                  only be one module path.                           #
810 #                                                                     #
811 #  syntaxhints   - If set to yes, true or 1, when a user does not     #
812 #                  give enough parameters for a command, a syntax     #
813 #                  hint will be given (using the RPL_TEXT numeric)    #
814 #                  as well as the standard ERR_NEEDMOREPARAMS.        #
815 #                                                                     #
816 #  announcets    - If this value is defined to yes, true, or 1, then  #
817 #                  a channels' timestamp is updated, the users on     #
818 #                  the channel will be informed of the change via     #
819 #                  a server notice to the channel with the old and    #
820 #                  new TS values in the timestamp. If you think this  #
821 #                  is just pointless noise, define the value to 0.    #
822 #                                                                     #
823 #  ircumsgprefix - Use undernet style message prefix for channel      #
824 #                  NOTICE and PRIVMSG adding the prefix to the line   #
825 #                  of text sent out. Eg. NOTICE @#test :@ testing     #
826 #                  vs. the off setting: NOTICE @#test :testing        #
827 #                                                                     #
828 #  hostintopic   - If this is set to yes (the default) then the full  #
829 #                  nick!user@host is shown for who set a TOPIC last.  #
830 #                  if set to no, then only the nickname is shown.     #
831 #                                                                     #
832 #  serverpingfreq- This value, when set, allows you to change the     #
833 #                  frequency of server to server PING messages. This  #
834 #                  can help if you are having certain network issues. #
835 #                                                                     #
836 #  pingwarning   - This should be set to a number between 1 and 59 if #
837 #                  defined, and if it is defined will cause the server#
838 #                  to send out a warning via snomask +l if a server   #
839 #                  does not answer to PING after this many seconds.   #
840 #                  This can be useful for finding servers which are   #
841 #                  at risk of pinging out due to network issues.      #
842 #                                                                     #
843 #  exemptchanops - This option allows channel operators to be exempted#
844 #                  from certain channel modes.                        #
845 #                  Supported modes are +SfFgNc. Defaults to off.      #
846 #                                                                     #
847 #  defaultmodes  - The default modes to be given to each channel on   #
848 #                  creation. Defaults to 'nt'. There should be no +   #
849 #                  or - symbols in this sequence, if you add them     #
850 #                  they will be ignored. You may add parameters for   #
851 #                  modes which take them.                             #
852 #                                                                     #
853 #  moronbanner   - The NOTICE to show to users who are glined, zlined #
854 #                  klined or qlined when they are disconnected. This  #
855 #                  is totally freeform, you may place any text here   #
856 #                  you wish.                                          #
857 #                                                                     #
858
859 <options prefixquit="Quit: "
860          suffixquit=""
861          prefixpart="\""
862          suffixpart="\""
863          noservices="no"
864          qprefix="~"
865          aprefix="&"
866          deprotectself="no"
867          deprotectothers="no"
868          syntaxhints="no"
869          cyclehosts="yes"
870          ircumsgprefix="no"
871          announcets="yes"
872          hostintopic="yes"
873          pingwarning="15"
874          serverpingfreq="60"
875          allowhalfop="yes"
876          defaultmodes="nt"
877          moronbanner="You're banned! Email haha@abuse.com with the ERROR line below for help."
878          exemptchanops="">
879
880
881 #-#-#-#-#-#-#-#-#-#-#-# PERFORMANCE CONFIGURATION #-#-#-#-#-#-#-#-#-#-#
882 #                                                                     #
883 #  maxwho        - The maximum number of results returned by a /WHO   #
884 #                  query. This is to prevent /WHO being used as a     #
885 #                  spam vector or means of flooding an ircd. The      #
886 #                  default is 128, it is not recommended to raise it  #
887 #                  above 1024. Values up to 65535 are permitted. If   #
888 #                  this value is omitted, any size WHO is allowed by  #
889 #                  anyone.                                            #
890 #                                                                     #
891 #  somaxconn     - The maximum number of sockets that may be waiting  #
892 #                  in the accept queue. This usually allows the ircd  #
893 #                  to soak up more connections in a shorter space of  #
894 #                  time when increased but please be aware there is a #
895 #                  system defined maximum value to this, the same way #
896 #                  there is a system defined maximum number of file   #
897 #                  descriptors. Some systems may only allow this to   #
898 #                  be up to 5 (ugh) while others such as FreeBSD will #
899 #                  default to a much nicer 128.                       #
900 #                                                                     #
901 #  softlimit     - This optional feature allows a defined softlimit.  #
902 #                  if defined sets a soft maxconnections value, has   #
903 #                  to be less than the ./configure maxclients         #
904 #                                                                     #
905 #  nouserdns     - If set to yes, true or 1, no user DNS lookups      #
906 #                  will be performed for connecting users. This can   #
907 #                  save a lot of resources on very busy IRC servers.  #
908 #                                                                     #
909 #  quietbursts   - When synching or splitting from the network, a     #
910 #                  server can generate a lot of connect and quit      #
911 #                  snotices to the +C and +Q snomasks. Setting this   #
912 #                  value to yes squelches those messages, which can   #
913 #                  make them more useful for opers, however it will   #
914 #                  degrade their use by certain third party programs  #
915 #                  such as BOPM which rely on them to scan users when #
916 #                  a split heals in certain configurations.           #
917 #                                                                     #
918 #  netbuffersize - Size of the buffer used to receive data from       #
919 #                  clients. The ircd may only read() this amount      #
920 #                  of text in one go at any time. (OPTIONAL)          #
921 #                                                                     #
922
923 <performance netbuffersize="10240"
924              maxwho="128"
925              somaxconn="128"
926              softlimit="12800"
927              quietbursts="yes"
928              nouserdns="no">
929
930 #-#-#-#-#-#-#-#-#-#-#-# SECURITY CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
931 #                                                                     #
932 # announceinvites                                                     #
933 #                - If this option is set, then invites are announced  #
934 #                  to the channel when a user invites another user.   #
935 #                  If you consider this to be unnecessary noise,      #
936 #                  set this to 'none'. To announce to all ops, set    #
937 #                  this to 'ops' and to announce to all users set the #
938 #                  value to 'all'.                                    #
939 #                                                                     #
940 #                  The value 'dynamic' varies between 'ops' and 'all' #
941 #                  settings depending on if the channel is +i or not. #
942 #                  When the channel is +i, messages go only to ops,   #
943 #                  and when the channel is not +i, messages go to     #
944 #                  everyone. In short, the messages will go to every  #
945 #                  user who has power of INVITE on the channel. This  #
946 #                  is the recommended setting.                        #
947 #                                                                     #
948 #  disablehmac   - If you are linking your InspIRCd to older versions #
949 #                  then you can specify this option and set it to     #
950 #                  yes. 1.1.6 and above support HMAC and challenge-   #
951 #                  response for password authentication. These can    #
952 #                  greatly enhance security of your server to server  #
953 #                  connections when you are not using SSL (as is the  #
954 #                  case with a lot of larger networks). Linking to    #
955 #                  older versions of InspIRCd should not *usually* be #
956 #                  a problem, but if you have problems with HMAC      #
957 #                  authentication, this option can be used to turn it #
958 #                  off.                                               #
959 #                                                                     #
960 #  hidemodes     - If this option is enabled, then the listmodes      #
961 #                  given (e.g. +eI), will be hidden from users below  #
962 #                  halfop. This is not recommended to be set on mode  #
963 #                  +b, as it may break some features in popular       #
964 #                  clients such as mIRC.                              #
965 #                                                                     #
966 #  hidesplits    - When set to 'yes', will hide split server names    #
967 #                  from non-opers. Non-opers will see '*.net *.split' #
968 #                  instead of the server names in the quit message,   #
969 #                  identical to the way IRCu displays them.           #
970 #                                                                     #
971 #  hidebans      - When set to 'yes', will hide gline, kline, zline   #
972 #                  and qline quit messages from non-opers. For        #
973 #                  example, user A who is not an oper will just see   #
974 #                  (G-Lined) while user B who is an oper will see the #
975 #                  text (G-Lined: Reason here) instead.               #
976 #                                                                     #
977 #  hidewhois     - When defined with a non-empty value, the given     #
978 #                  text will be used in place of the user's server    #
979 #                  in WHOIS, when a user is WHOISed by a non-oper.    #
980 #                  For example, most nets will want to set this to    #
981 #                  something like '*.netname.net' to conceal the      #
982 #                  actual server the user is on.                      #
983 #                                                                     #
984 #  flatlinks     - When you are using m_spanningtree.so, and this     #
985 #                  value is set to yes, true or 1, /MAP and /LINKS    #
986 #                  will be flattened when shown to a non-opers.       #
987 #                                                                     #
988 #  hideulines    - When you are using m_spanningtree.so, and this     #
989 #                  value is set to yes, true or 1, then U-lined       #
990 #                  servers will be hidden in /LINKS and /MAP for non  #
991 #                  opers. Please be aware that this will also hide    #
992 #                  any leaf servers of a U-lined server, e.g. jupes.  #
993 #                                                                     #
994 #  userstats     - The userstats field is optional and specifies      #
995 #                  which stats characters in /STATS may be requested  #
996 #                  by non-operators. Stats characters in this field   #
997 #                  are case sensitive and are allowed to users        #
998 #                  independent of if they are in a module or the core #
999 #                                                                     #
1000 #  operspywhois  - If this is set then when an IRC operator uses      #
1001 #                  /WHOIS on a user they will see all channels, even  #
1002 #                  ones if channels are secret (+s), private (+p) or  #
1003 #                  if the target user is invisible +i.                #
1004 #                                                                     #
1005 #  customversion - If you specify this configuration item, and it is  #
1006 #                  not set to an empty value, then when a user does   #
1007 #                  a /VERSION command on the ircd, this string will   #
1008 #                  be displayed as the second portion of the output,  #
1009 #                  replacing the system 'uname', compile flags and    #
1010 #                  socket engine/dns engine names. You may use this   #
1011 #                  to enhance security, or simply for vanity.         #
1012 #                                                                     #
1013 #  maxtargets    - The maxtargets field is optional, and if not       #
1014 #                  defined, defaults to 20. It indicates the maximum  #
1015 #                  number of targets which may be given to commands   #
1016 #                  such as PRIVMSG, KICK etc.                         #
1017 #                                                                     #
1018 #  hidekills     - The hidekills value, if set, replaces the source   #
1019 #                  of all oper-generated kills to be the given text   #
1020 #                  to provide anonimity to your opers.                #
1021 #                                                                     #
1022
1023 <security announceinvites="dynamic"
1024           hidemodes="eI"
1025           disablehmac="no"
1026           hideulines="no"
1027           flatlinks="no"
1028           hidewhois=""
1029           hidebans="no"
1030           hidekills=""
1031           hidesplits="no"
1032           maxtargets="20"
1033           customversion=""
1034           operspywhois="no"
1035           userstats="Pu">
1036
1037 #-#-#-#-#-#-#-#-#-#-#-#-# LIMITS CONFIGURATION  #-#-#-#-#-#-#-#-#-#-#-#
1038 #                                                                     #
1039 # This configuration tag defines the maximum sizes of various types   #
1040 # on IRC, such as the maximum length of a channel name, and the       #
1041 # maximum length of a channel. Note that with the exception of the    #
1042 # identmax value all values given here are the exact values you would #
1043 # expect to see on IRC. This contrasts with the older InspIRCd        #
1044 # releases where these values would be one character shorter than     #
1045 # defined to account for a null terminator on the end of the text.    #
1046 #                                                                     #
1047 # The identmax value has special meaning, as it may grow one          #
1048 # character longer than you specify, to accomodate for a ~ character  #
1049 # when m_ident is loaded.                                             #
1050 #                                                                     #
1051 # These values should match network-wide, otherwise you may end up    #
1052 # with desyncs, and confusing your users by being able to use a nick  #
1053 # of a certain length on one server but not on another. Servers will  #
1054 # link with mismatched values, but this is NOT recommended as a long  #
1055 # term measure!                                                       #
1056 #                                                                     #
1057 # Values here should be self explanitory:                             #
1058 #                                                                     #
1059 # maxnick         - The maximum length of a nickname                  #
1060 # maxchan         - The maximum length of a channel name              #
1061 # maxmodes        - The maximum number of parameterized mode changes  #
1062 #                   per line                                          #
1063 # maxident        - The maximum length of an ident/username value     #
1064 # maxquit         - The maximum length of a quit message              #
1065 # maxtopic        - The maximum length of a channel topic             #
1066 # maxkick         - The maximum length of a kick message              #
1067 # maxgecos        - The maximum length of a GECOS (real name)         #
1068 # maxaway         - The maximum length of an away message             #
1069 #                                                                     #
1070
1071 <limits maxnick="31"
1072         maxchan="64"
1073         maxmodes="20"
1074         maxident="11"
1075         maxquit="255"
1076         maxtopic="307"
1077         maxkick="255"
1078         maxgecos="128"
1079         maxaway="200">
1080
1081
1082 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1083 # Logging
1084 # -------
1085 #
1086 # Logging is covered with the <log> tag, which you may use to change
1087 # the behaviour of the logging of the IRCd.
1088 #
1089 # In InspIRCd as of 1.2, logging is pluggable and very extensible.
1090 # Different files can log the same thing, different 'types' of log can
1091 # go to different places, and modules can even extend the log tag
1092 # to do what they want.
1093 #
1094 # An example log tag would be:
1095 #       <log method="file" type="OPER" level="default" target="opers.log">
1096 # which  would log all information on /oper (failed and successful) to
1097 # a file called opers.log.
1098 #
1099 # There are many different types which may be used, and modules may
1100 # generate their own. A list of useful types:
1101 #       - USERS - information relating to user connection and disconnection
1102 #       - CHANNELS - information relating to joining and parting of channels.
1103 # XXX someone doc more on this
1104 #
1105 # You may also log *everything* by using a type of *, and subtract things out
1106 # of that by using -TYPE - for example "* -USERINPUT -USEROUTPUT".
1107 #
1108 # Channel Logging
1109 # ---------------
1110 #
1111 # I'm aware this would probably better belong in the modules section, but this
1112 # is heavily interrelated to logging, and as such will be documented here.
1113 #
1114 # m_chanlog is one of the modules which can alter logging to it's own thing.
1115 # An example of this may be:
1116 #
1117 #<module name="m_chanlog.so">
1118 #<log method="channel" type="OPER USERS CHANNELS" level="default" target="#services">
1119 #
1120 # The following log tag is highly default and uncustomised. It is recommended you
1121 # sort out your own log tags. This is just here so you get some output.
1122 <log method="file" type="* -USERINPUT -USEROUTPUT -m_spanningtree" level="default" target="ircd.log">
1123
1124 #-#-#-#-#-#-#-#-#-#-#-#-#-  WHOWAS OPTIONS   -#-#-#-#-#-#-#-#-#-#-#-#-#
1125 #                                                                     #
1126 # This tag lets you define the behaviour of the /whowas command of    #
1127 # your server.                                                        #
1128 #                                                                     #
1129 # groupsize      - Controls the maximum entries per nick shown when   #
1130 #                  performing a /whowas nick. Setting this to 0 dis-  #
1131 #                  ables whowas completely.                           #
1132 #                                                                     #
1133 # maxgroups      - The maximum number of nickgroups that can be added #
1134 #                  to the list. If max is reached, oldest group will  #
1135 #                  be deleted first like a FIFO. A groupsize of 3 and #
1136 #                  a maxgroups of 5000 will allow for 5000 nicks to   #
1137 #                  be stored with a history of 3, thus giving a total #
1138 #                  of 3 * 5000 = 15000 entries. A setting of 0 dis-   #
1139 #                  ables whowas completely.                           #
1140 #                                                                     #
1141 # maxkeep        - The maximum time a nick is kept in the whowas list #
1142 #                  before being pruned. Time may be specified in      #
1143 #                  seconds, or in the following format: 1y2w3d4h5m6s  #
1144 #                  meaning one year, two weeks, three days, 4 hours,  #
1145 #                  5 minutes and 6 seconds. All fields in this format #
1146 #                  are optional. Minimum is 1 hour, if less InspIRCd  #
1147 #                  will default back to 1 hour.                       #
1148 #                                                                     #
1149 #<whowas groupsize="10"                                               #
1150 #        maxgroups="100000"                                           #
1151 #        maxkeep="3d">                                                #
1152
1153 #-#-#-#-#-#-#-#-#-#-#-#-#-#-  BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1154 #                                                                     #
1155 # The ban tags define nick masks, host masks and ip ranges which are  #
1156 # banned from your server. All details in these tags are local to     #
1157 # Your server.                                                        #
1158 #                                                                     #
1159 #                                                                     #
1160 # badip lines ban an ip range (same as a zline)                       #
1161 #                                                                     #
1162 # ipmask       -          The ip range to ban (wildcards possible)    #
1163 #                         CIDR is supported in the IP mask.           #
1164 # reason       -          Reason to display when disconnected         #
1165 #                                                                     #
1166 # badnick lines ban a nick mask (same as a qline)                     #
1167 #                                                                     #
1168 # nick         -          Nick mask to ban (wildcards possible)       #
1169 # reason       -          Reason to display on /NICK                  #
1170 #                                                                     #
1171 # badhost lines ban a user@host mask (same as a kline)                #
1172 #                                                                     #
1173 # host         -          ident@hostname (wildcards possible)         #
1174 #                         If you specify an IP, CIDR is supported.    #
1175 # reason       -          Reason to display on disconnection          #
1176 #                                                                     #
1177 # exception lines define a hostmask that is excempt from [kzg]lines   #
1178 #                                                                     #
1179 # host         -          ident@hostname (wildcards possible)         #
1180 #                         If you specify an IP, CIDR is supported.    #
1181 # reason       -          Reason, shown only in /stats e              #
1182 #                                                                     #
1183
1184 <badip ipmask="69.69.69.69" reason="No porn here thanks.">
1185
1186 <badnick nick="ChanServ" reason="Reserved For Services">
1187 <badnick nick="NickServ" reason="Reserved For Services">
1188 <badnick nick="OperServ" reason="Reserved For Services">
1189 <badnick nick="MemoServ" reason="Reserved For Services">
1190
1191 <badhost host="*@hundredz.n.hundredz.o.1337.kiddies.com" reason="Too many 1337 kiddiots">
1192 <badhost host="*@localhost" reason="No irc from localhost!">
1193 <badhost host="*@172.32.0.0/16" reason="This subnet is bad.">
1194
1195 <exception host="*@ircop.host.com" reason="Opers hostname">
1196
1197 #-#-#-#-#-#-#-#-#-#-#- INSANE BAN OPTIONS  -#-#-#-#-#-#-#-#-#-#-#-#-#-#
1198 #                                                                     #
1199 # This optional tag allows you to specify how wide a gline, eline,    #
1200 # kline, zline or qline can be before it is forbidden from being      #
1201 # set. By setting hostmasks="yes", you can allow all G, K, E lines,   #
1202 # no matter how many users the ban would cover. This is not           #
1203 # recommended! By setting ipmasks="yes", you can allow all Z lines,   #
1204 # no matter how many users these cover too. Needless to say we        #
1205 # don't recommend you do this, or, set nickmasks="yes", which will    #
1206 # allow any qline.                                                    #
1207 #                                                                     #
1208 # The trigger value indicates how wide any mask will be before it is  #
1209 # prevented from being set. The default value is 95.5% if this tag is #
1210 # not defined in your configuration file, meaning that if your        #
1211 # network has 1000 users, a gline matching over 955 of them will be   #
1212 # prevented from being added.                                         #
1213 #                                                                     #
1214 # Please note that remote servers (and services) are exempt from      #
1215 # these restrictions and expected to enforce their own policies       #
1216 # locally!                                                            #
1217 #                                                                     #
1218
1219 <insane hostmasks="no" ipmasks="no" nickmasks="no" trigger="95.5">
1220
1221
1222 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#- YAWN  -#-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1223 #                                                                     #
1224 #   You should already know what to do here :)                        #
1225
1226 <die value="User error. Insert new user and press any key. (you didn't edit your config properly.)">
1227
1228 #-#-#-#-#-#-#-#-#-#-#-#-#-#-#-#-# MODULES #-#-#-#-#-#-#-#-#-#-#-#-#-#-#
1229 #    ____                _   _____ _     _       ____  _ _   _        #
1230 #   |  _ \ ___  __ _  __| | |_   _| |__ (_)___  | __ )(_) |_| |       #
1231 #   | |_) / _ \/ _` |/ _` |   | | | '_ \| / __| |  _ \| | __| |       #
1232 #   |  _ <  __/ (_| | (_| |   | | | | | | \__ \ | |_) | | |_|_|       #
1233 #   |_| \_\___|\__,_|\__,_|   |_| |_| |_|_|___/ |____/|_|\__(_)       #
1234 #                                                                     #
1235 # Well done, you've reached the end of this.                          #
1236 # We now suggest you read and edit modules.conf, as modules are what  #
1237 # provide almost all the features of InspIRCd. :)                     #
1238 #                                                                     #
1239 # The default does nothing -- we include it for simplicity for you.   #
1240 <include file="modules.conf">
1241
1242
1243 #########################################################################
1244 #                                                                       #
1245 #                     - InspIRCd Development Team -                     #
1246 #                        http://www.inspircd.org                        #
1247 #                                                                       #
1248 #########################################################################