]> jfr.im git - irc/evilnet/x3.git/blob - x3.conf.example
Moved defcon gline check out to check_new_user and added a shun check also for defcon
[irc/evilnet/x3.git] / x3.conf.example
1 /* *****************************************************************
2 * X3 Services Example Configuration file.
3 *
4 * Copy it to your x3 runtime dir, and edit to taste.
5 *
6 * This file allows two kinds of comments. Whitespaces between
7 * tokens are ignored. All strings (even if they're just numbers)
8 * MUST be enclosed in double quotes. There must be a semicolon
9 * after every * key/value pair.
10 */
11
12 /* UPLINKS (servers we connect to) *********************************
13 * Each subsection describes one server. X3 will try to connect to
14 * each in turn maxtries times, and then will quit.
15 */
16 "uplinks" {
17 // This first entry connects to an ircd on teh same server an X3..
18 "Hub" { // This can be any string, just used here for your conveniance
19 "address" "127.0.0.1"; // The IP address of the server
20 "port" "8888"; // What TCP port to connect to
21 "password" "laoo,rpe"; // Both of these passwords must match
22 "their_password" "laoo,rpe"; // the one in the ircd C line for X3.
23 "enabled" "1"; // Set to 0 to disable connecting to this server
24 "max_tries" "10"; // How many times to attemt reconnect before quitting
25 "bind_address" "127.0.0.1"; // LOCAL IP address we want to connect FROM
26 };
27 // This next one connects to an ircd on another server
28 "Hub-west" {
29 // IP address and port the server listens on
30 "address" "192.168.234.123"; // IP of remote server
31 "port" "8888";
32 "password" "ekrpat"; // C line passwords
33 "their_password" "ekrpat"; // Set same as above
34 "enabled" "0"; // Set this to 1 to use this server..
35 "max_tries" "1";
36 "bind_address" "192.168.1.10";
37 };
38 };
39
40 /* SERVER (Details about our existance) **********************************
41 */
42 "server" {
43 "hostname" "X3.AfterNET.Services"; // The servers name. (Use this in the ircd's C line)
44 "description" "AfterNET Network Services"; // Shows up in /links.
45 "network" "AfterNET";
46 "hidden_host" "Users.AfterNET.Org"; // set this if you enabled Nefarious' +x mode
47 /* hidden_host should match the F:HIDDEN_HOST: line in your ircu's ircd.conf;
48 * x3 does not set the host suffix for users, but must know it when making
49 * things like bans, where it should not show the user's real hostname. */
50 "numeric" "51"; // hint: If you get collisions on link, CHANGE THIS.
51 /* Type handles some changes in nefarious 1.0 (was 0.5.0)
52 * 4 - nefarious 0.4.x and other ircds
53 * 5 - nefarious 1.0.x and higher
54 */
55 "type" "5";
56 "host_in_topic" "1"; //Set to 1 if your Nefarious server have the HOST_IN_TOPIC F:line set to TRUE.
57 "max_users" "256"; // You can save a little memory by setting this to a lower value.
58 "force_n2k" "1"; // Use extended (5-digit) numnick for self, even if 3 are possible.
59 "ping_freq" "60";
60 "ping_timeout" "90";
61 "max_cycles" "30"; // max uplink cycles before giving up
62 // Admin information is traditionally: location, location, email
63 // This shows up on a /admin x3.afternet.services command.
64 "admin" (
65 "AfterNET IRC Network",
66 "www.afternet.org",
67 "Support Staff <support@afternet.org>"
68 );
69 /* extended_accounts -
70 * enable this for nefarious 0.4.x and higher and in ircd.conf add F:EXTENDED_ACCOUNTS:TRUE.
71 * Sends 'AC R nick account' instead of 'AC nick account' and allows
72 * for renames, login-on-connect, etc. If you use stock ircu set to 0. */
73 "extended_accounts" "1";
74
75 /* the following two settings are for ircu's HEAD_IN_SAND features, and are equivelent to
76 * the F: lines in ircu's ircd.conf. both can be disabled by commenting them out. */
77 //"his_servername" "*.AfterNET.org"; // hidden server name, shown in remote /whois requests
78 //"his_servercomment" "AfterNET IRC Network";
79 };
80
81 /* SERVICES (Bot nicknames) *******************************************
82 * Each section describes one service nickname and the details of that
83 * bot's features
84 * You may disable a service by commenting out its "nick" config item.
85 */
86 "services" {
87 /* Nickserv is the bot you register with and auth to.
88 * Afternet uses the name "Authserv" without the nickname reservation
89 * features enabled. Some nets call it Nickserv and configure it to
90 * reserve nicks.
91 */
92 "nickserv" {
93 "nick" "AuthServ"; // The bots nick on IRC
94
95 // If you want to have *@* as the default hostmask, set
96 // default_hostmask. I highly reccomend this, and its required
97 // for login-on-connect to work.
98 "default_hostmask" "1";
99
100 // do we warn users when someone new auths to their account?
101 "warn_clone_auth" "1"; // -X3- warning: foobar has authed to your account
102
103 // default max number of logins allowed on new accounts. Users can set it
104 // to something different using authserv commands.
105 "default_maxlogins" "3";
106
107 // hard_maxlogins is the ammount the user cant override.
108 "hard_maxlogins" "10";
109
110 // This names a file that contains easily guessed passwords.
111 // It always contains "password", "<password>" and the user's
112 // account name.
113 // uncomment if you have a dict file.
114 //"dict_file" "/usr/share/dict/words";
115
116 // Minimum number of various types of characters permitted in
117 // a password. Authserv will enforce these.
118 "password_min_length" "4";
119 "password_min_digits" "0";
120 "password_min_upper" "0";
121 "password_min_lower" "0";
122
123 // What should valid account and nicks look like?
124 // If valid_nick_regex is omitted, valid_account_regex is used
125 // for both nicks and accounts.
126 // Be very carefull changing these. This default is
127 // basically limited to letters, numbers, dash and underscore.
128 "valid_account_regex" "^[-_a-z0-9A-Z]{2,15}$";
129 "valid_nick_regex" "^[-_a-z][-_a-z0-9]*$";
130
131 // Whats a valid hostname look like for fakehosts?
132 "valid_fakehost_regex" "^[-_a-zA-Z0-9.]+$";
133
134 // "Nickserv" networks, set this to 0. "Authserv" networks,
135 // set it to 1.
136 "disable_nicks" "1";
137 // One account may only own this many nicks.
138 "nicks_per_account" "4";
139
140 // Send a warning when someone uses a registered nick?
141 "warn_nick_owned" "0";
142
143 // What to do when someone uses the NickServ "reclaim" command?
144 // This can be one of "none", "warn", "svsnick", or "kill", but
145 // stock ircu does not support svsnick -- you need Bahamut or
146 // nefarious.
147 "reclaim_action" "none";
148
149 // What (else) to do when someone uses a registered nick?
150 // This can be anything "reclaim_action" can be, but it makes
151 // more sense to use the "warn_nick_owned" instead of "warn".
152 "auto_reclaim_action" "none";
153
154 // How long to wait before doing the auto_reclaim_action?
155 // This is ignored if "auto_reclaim_action" is "none".
156 "auto_reclaim_delay" "0";
157
158 // access control for who can change account flags
159 // See /msg authserv help account flags
160 "flag_levels" {
161 "g" "800"; // God mode
162 "lc_h" "800"; // support helper (lower case h)
163 "uc_H" "800"; // net helper (upper case H)
164 "S" "999"; // O3 access suspended
165 "b" "1"; // Bot (not sure what it does tho)
166 };
167
168 // and for who can change epithets for staff
169 // epithets show up in /whois as another line about the person.
170 "set_epithet_level" "800";
171
172 // what opserv access level do you need to set somebody else's level?
173 "modoper_level" "850";
174
175 // how often should accounts be expired?
176 "account_expire_freq" "1d";
177
178 // how long until an account with access to any channel(s) expires?
179 "account_expire_delay" "900d";
180
181 // how long until an account with no access to any channels expires?
182 "nochan_account_expire_delay" "365d";
183
184 // If somebody keeps guessing passwords incorrectly, do we gag them?
185 "autogag_enabled" "1";
186 "autogag_duration" "30m";
187 "auth_policer" {
188 "size" "5";
189 "drain-rate" "0.05";
190 };
191
192 // How to integrate with email cookies?
193 // In order to use mail, mail must be enabled and configured
194 // down below in the mail section of this config file.
195 "email_enabled" "1"; // Allow account verification and password reset by email.
196 "email_required" "1"; // if above is 1, require verification to authenticate.
197 "cookie_timeout" "2d"; // how long before we expire cookies?
198 "accounts_per_email" "1"; // How many people can use the same email account.
199
200 "email_search_level" "600"; // minimum OpServ level to search based on email address (search print email *foo*)
201 "email_visible_level" "800"; // minimum OpServ level to see somebody's email address
202 "titlehost_suffix" "AfterNET.Org"; // 'USET title' sets a fake hostname of name.title.titlehost on a user.
203 "set_title_level" "900"; // Access to use 'uset title'.
204 "set_fakehost_level" "1000"; //Access to set a freeform fakehost. (uset fakehost)
205
206 // A list of denied words in the fakehosts
207 "denied_fakehost_words" ("sex",
208 "fuck",
209 "asshole");
210
211 // This is a hacked in feature which exports every account change to a file sync.log. Afternet uses this and
212 // a bunch of custom PHP scripts to make our websites SQL user db the same as authserv, every 5 minutes.
213 // You have to be a pretty handy person with the shell commands and programming to make use of this..
214 "sync_log" "0"; // Log account changes to a file for syncing w/ a website?
215
216 // Nickserv 'style' setting affects .userlist and other outputs.
217 "default_style" "n"; // can be: n = normal, c = clean, or a = advanced.
218 };
219
220 /*
221 * OpServ is the bot opers use to do glines, look at info etc.
222 * Afternet uses the nickname "O3" for this as its easier to type.
223 */
224 "opserv" {
225 "nick" "O3";
226 // should use of this service be limited to global opers?
227 "privileged" "1";
228
229 // fullname for service
230 "description" "Oper Service Bot"; // (for /whois)
231
232 // hostname for service; only used if "description" is also set
233 "hostname" "X3.AfterNET.Services"; // (for /whois)
234
235 // What channel should opserv send debug output to?
236 // I don't have any idea what debug info goes here. You can configure
237 // debugging logs in the log section to go to any channel.
238 // Probably safest to set to your oper channel.
239 "debug_channel" "#TheOps"; // Bot will join this channel, also.
240 "debug_channel_modes" "+tnOS"; // Modes get set every time X3 starts up
241
242 // where to send general alerts (e.g. flood alerts)?
243 "alert_channel" "#TheOps"; // Bot will join this channel, also.
244 "alert_channel_modes" "+"; // Modes get set every time X3 starts up
245
246 // who to tell about staff auths?
247 "staff_auth_channel" "#OperServ"; // Bot will join this channel, also.
248 "staff_auth_channel_modes" "+tnOs"; // modes get set every time X3 starts up
249
250 // which channels should all services autojoin?
251 "autojoin_channels" ("#TheOps", "#OperServ");
252
253 // how many clones to allow from an untrusted host?
254 // Use this carefully, users with half the # of clones will trigger this
255 // when a server pings out and they reconnect before the old connection is noticed
256 // to be dead by the server.. so set it at about twice the # you want to allow to
257 // avoid false positives.
258 "untrusted_max" "6"; // 3 connections and 3 ghosts, 7th connection causes a gline.
259
260 // how long of a g-line should be issued if the max hosts is exceeded?
261 "clone_gline_duration" "2h"; // durations are smhdmy
262
263 // how long to g-line for ?block (or, by default, for trace gline)?
264 "block_gline_duration" "12h";
265
266 // how long to shun for ?sblock (or, by default, for trace shun)?
267 "block_shun_duration" "12h";
268
269 // When a user joins an illegal channel, O3 joins it and locks it down.
270 // how long to keep an illegal channel locked down (seconds)?
271 "purge_lock_delay" "60";
272
273 // ------------------------------------------------------------------
274 // Defcon Settings
275 //
276 // No new channel registrations 1
277 // No New Nick Registrations 2
278 // No Channel Mode changes 4
279 // Force Chan Mode 8
280 // Use Reduced Session Limit 16
281 // KILL any new clients trying to connect 32
282 // Services will ignore everyone but opers 64
283 // Services will silently ignore everyone but opers 128
284 // GLINE all new clients trying to connect 256
285 // No new memos sent to block MemoServ attacks 512
286 // SHUN all new clients trying to connect 1024
287 //
288 // These are the values are added together to determine each defcon setting:
289 "DefCon1" "415";
290 "DefCon2" "159";
291 "DefCon3" "31";
292 "DefCon4" "23";
293
294 // Default defcon level, 5 is running all normally
295 "DefConLevel" "5";
296
297 // If defcon is limiting sessions then how many sessions should O3 allow?
298 "DefConSessionLimit" "2";
299
300 // Length of glines and shuns set on newly connecting clients, if defcon is glining
301 // or shunning newly connecting clients
302 "DefConGlineExpire" "5m";
303
304 // Mode to set on all channels if defcon is forcing channel modes on all channels
305 "DefConChanModes" "+r";
306
307 // If not set to 0, defcon will set back to level 5 after this time
308 "DefConTimeOut" "15m";
309
310 // Where will the user global notices go to?
311 // 1 - Users Only
312 // 2 - Channels Only
313 // 3 - Both Users and Channels
314 "DefConGlobalTarget" "3";
315
316 // Set to 1 to send a notice to all users when defcon levels are changed
317 "GlobalOnDefcon" "0";
318
319 // If set to 1 along with the notice that the levels are changing an extra
320 // notice will be sent
321 "GlobalOnDefconMore" "0";
322
323 // GlobalOnDefconMore notice.
324 "DefconMessage" "Put your message to send your users here. Dont forget to uncomment GlobalOnDefconMore";
325
326 // This notice will be used if GlobalOnDefcon and GlobalOnDefconMore are off
327 "DefConOffMessage" "Services are now back to normal, sorry for any inconvenience";
328
329 // Reason placed in defcon Glines and Shuns.
330 "DefConGlineReason" "This network is currently not accepting connections, please try again later";
331
332 // ------------------------------------------------------------------
333
334 // The join-flood policer code goes off all the time when a server
335 // goes down (and everyone reconnects) so i don't reccomend using it.
336 // Automatically moderate join flooded channels?
337 "join_flood_moderate" "0";
338 // channel join flood policer params?
339 "join_policer" {
340 "size" "20";
341 "drain-rate" "1";
342 };
343 // Don't moderate and warn channels unless there are more than
344 // join_flood_moderate_threshold users in the channel. the
345 // value 0 will disable the threshold.
346 "join_flood_moderate_threshold" "50";
347 // new user flood policer params
348 "new_user_policer" {
349 "size" "200";
350 "drain-rate" "3";
351 };
352 // Min opserv level needed to set 'silent' glines in trace/addalert
353 // (nefarious only)
354 "silent_level" "700";
355 };
356
357 "chanserv" {
358 "nick" "X3";
359
360 // The umodes - add +d if you use nefarious 1.0 and you added 'b:lines'
361 // to pass cmdchar through to chanserv anyway.
362 "modes" "+iok";
363
364 // The off_channel setting takes one of three numerical values:
365 // 0 = off
366 // 1 = use a registered channel mode, have services op themselves
367 // 2 = all of the above, and a channel setting to have ChanServ not
368 // idle in the channel
369 // NOTE: +z mode, needed for this to work, is inharently flawed and
370 // will cause desynch, so don't use it IMO -Rubin.
371 "off_channel" "no";
372
373 // Infolines are sent when channel users join the channel. Users set them with USET INFO in X3.
374 // how long should a person be unseen before resending infoline?
375 "info_delay" "120";
376
377 // Greetings can be configured by the channel manager(s) and sent to users who join the channel.
378 // Many people (rightly) find this annoying, so keep them short.
379 // maximum greeting length
380 "max_greetlen" "120";
381
382 // maximum users in a channel userlist
383 "max_chan_users" "512";
384 // maximum bans on a channel banlist
385 "max_chan_bans" "512";
386 // maximum length of a user's infoline
387 "max_userinfo_length" "400"; // for god sake lower this. 80 seems good.
388
389 // If SET DynLimit is on and there are N users in the channel, ChanServ will
390 // try to keep the limit at N+<adjust_threshold>. This makes the channel
391 // somewhat protected from clone attacks.
392 "adjust_threshold" "5";
393 // .. but ChanServ will only increment or decrement the limit this often.
394 "adjust_delay" "30"; // (seconds)
395
396 // How often to look for expired bans?
397 "ban_timeout_freq" "2m";
398
399 // How often to look for channels that have expired?
400 "chan_expire_freq" "1d";
401
402 // How long is a channel unvisited (by masters or above) before it can be expired?
403 "chan_expire_delay" "30d";
404
405 // what !set options should we show when user calls "!set" with no arguments?
406 "set_shows" ("DefaultTopic", "TopicMask", "Greeting", "UserGreeting", "Modes", "PubCmd", "InviteMe", "UserInfo", "EnfOps", "EnfModes", "EnfTopic", "TopicSnarf", "Setters", "CtcpReaction", "Voice", "Protect", "Toys", "DynLimit", "NoDelete");
407
408 // A list of !8ball responses
409 "8ball" (
410 "Are you out of your MIND?",
411 "It won't happen, not a chance, definitely no.",
412 "Outlook seems bleak.",
413 "My sources say no.",
414 "You bet!",
415 "It is decidedly so.",
416 "It's hard to be sure.",
417 "Most definitely.",
418 "In your dreams...",
419 "If the prophets wish it...",
420 "Forecast hazy, try again later.",
421 "I don't know!",
422 "Absolutely!",
423 "Never.",
424 "Yes.",
425 "No.",
426 "Maybe.");
427
428 // channel(s) that support helpers must be in to be helping
429 // if this is a list, any one by itself will do
430 "support_channel" ("#Operations", "#Help");
431
432 // maximum number of channels a user may have. ( FORCE can override )
433 "max_owned" "2";
434
435 // how long between automatic topic and userlist refreshes with TopicRefresh/Resync
436 "refresh_period" "10h";
437
438 // what should !access say for various staff?
439 "irc_operator_epithet" "AfterNET IRC Operator";
440 "network_helper_epithet" "AfterNET Network Helper";
441 "support_helper_epithet" "AfterNET Support Helper";
442
443 // what should a newly registered channel get as its modes?
444 "default_modes" "+nt";
445
446 // minimum opserv access to set, clear or override channel nodelete setting?
447 "nodelete_level" "1";
448
449 // when does god mode time out?
450 "god_timeout" "30m";
451 };
452
453 /* Global is a service bot that can send out network-wide messages for you. I
454 * like to set ours' nick to 'AfterNET', but some people use 'Global'
455 */
456 "global" {
457 "nick" "Global";
458 // should users get community announcements by default or not?
459 // community announcements are a type of global that users may
460 // opt into (or out of, depending on this setting)
461 "announcements_default" "on";
462 };
463
464
465 "spamserv" {
466 // You may enable this service by removing the double slashes from the config
467 // item. To disable it again add the double slashes back.
468 // "nick" "SpamServ";
469
470 // debug channel
471 "debug_channel" "#operserv";
472
473 // url of the network rules. if you don't have network rules, remove this key.
474 "network_rules" "http://www.afternet.org/aup";
475
476 // trigger for spamserv; remove this key to disable the trigger
477 "trigger" "%";
478
479 // ban duration of a short timedban.
480 "short_ban_duration" "15m";
481
482 // ban duration of a long timedban.
483 "long_ban_duration" "1h";
484
485 // duration of a gline. SpamServ will issue it after several violations and a kill.
486 "gline_duration" "1h";
487
488 // users may add "exception_max" exceptions to the list. IRCOps can override "exception_max".
489 "exception_max" "10";
490
491 // minimum & maximum length of an exception.
492 "exception_min_len" "4";
493 "exception_max_len" "12";
494
495 // users may add "badword_max" badwords to the list. IRCOps can override badword_max".
496 "badword_max" "10";
497
498 // minimum & maximum length of an badword.
499 "badword_min_len" "4";
500 "badword_max_len" "12";
501
502 // if someone advertises a channel, which doesn't exist (channel is empty, no users),
503 // SpamServ doesn't punish the user.
504 // enable this setting, if SpamServ has to ignore advertisements of channels, which do not exist.
505 // disable this setting, if SpamServ has to punish the users whenever they advertise.
506 "adv_chan_must_exist" "1";
507
508 // remove all mirc codes from messages before checking for advertisements.
509 // if this setting is disabled and someone spams a url which
510 // contains a bold char, SpamServ doesn't punish him.
511 "strip_mirc_codes" "1";
512
513 // enable this, if SpamServ has to "follow" ChanServ, when a channel moves or merges.
514 // disable it, if it shouldn't be possible to move or merge SpamServ with /msg chanserv move|merge.
515 "allow_move_merge" "1";
516 };
517 };
518
519 /* MODULES (optional components) *************************************************
520 * These must be explicitly compiled in (see ./configure --help)
521 * When enabled, they are configured here..
522 */
523 "modules" {
524 /* Helpserv is a help-queue tracker module for your #support channels, if
525 * they are busy. It issues users tickets, and tracks the next available helper.
526 */
527 "helpserv" {
528 // The description/fullname field
529 "description" "Help Queue Manager"; // (for whois)
530
531 // HelpServ bots log all of their requests to this file, with
532 // details on when they were opened, closed, their contents,
533 // helper, etc. The file is written in saxdb format for easy
534 // parsing by external programs. Please note that you cannot
535 // use ?set to change this value while x3 is running.
536 "reqlogfile" "helpservreq.log";
537
538 // How long should a helpserv be inactive (no requests assigned)
539 // before it can be unregistered by the expire command?
540 "expiration" "60d";
541 };
542 /* SockCheck reads sockcheck.conf and can do configurable scans
543 * to probe for open relays in an attempt to stop drones from using
544 * the network. DO NOT enable this unless you have permission from
545 * your ISP.. the probes will show up as attacks on everyones firewalls
546 * and you will get a lot of complaints.
547 */
548 "sockcheck" {
549 // disabling this hopefully
550 "max_sockets" "0"; // 64 is a good # of concurrent clients to be checked
551 "max_read" "1024"; // don't read more than 1024 bytes from any client
552 "gline_duration" "1d"; // issue G-lines lasting one hour
553 "max_cache_age" "60"; // only cache results for 60 seconds
554 "address" "192.168.1.10"; // do proxy tests from this address
555 };
556 /* Snoop sends connect, quit, join, and part messages for every user
557 * on the network, and helps in finding drones. Put it somewhere secure
558 * so your users privacy is honored.
559 */
560 "snoop" {
561 // Where to send snoop messages?
562 "channel" "#MrSnoopy";
563 // Which bot?
564 "bot" "O3";
565 // Show new users and joins from net joins? (off by default)
566 "show_bursts" "0";
567 };
568 /* Track works just like Snoop except it only sends events for users
569 * who have been specified
570 */
571 "track" {
572 // What to track by default?
573 "snomask" "nick,join,part,kick,new,del,auth,chanmode,umode";
574 // Where to send snoop messages?
575 "channel" "#MrPeanuts";
576 // Which bot?
577 "bot" "O3";
578 // Show new users and joins from net joins? (off by default)
579 "show_bursts" "0";
580 };
581 /* Memoserv lets users send messages to other users accounts.
582 */
583 "memoserv" {
584 "bot" "MemoServ";
585 "message_expiry" "30d"; // age when messages are deleted; set
586 // to 0 to disable message expiration
587 "limit" "30"; // Max amount of messages a person can get.
588 };
589 };
590
591 "policers" {
592 "commands-luser" {
593 "size" "5";
594 "drain-rate" "0.5";
595 };
596 };
597
598 "rlimits" {
599 "data" "50M";
600 "stack" "6M";
601 "vmem" "100M";
602 };
603
604 /* MAIL (if and how X3 sends mail ) *********************************
605 * Mainly Authserv/Nickserv send mail, See the Nickserv
606 * section for additional mail settings also.
607 */
608 "mail" {
609 "enable" "1";
610 "mailer" "/usr/sbin/sendmail";
611 // OR Afternet uses a custom script to keep the services IP hidden:
612 // "mailer" "/home/x3user/x3/sendmail.sh";
613 "from_address" "supportrobot@afternet.org";
614 "extra_headers" ("AfterNET-Services: x3");
615 "body_prefix_first" ("Welcome to AfterNET, looks like this is your first email from us.");
616 "body_prefix" ("AfterNET Support - User and Channel registration system");
617 "body_suffix_first" ("", "AfterNET IRC Network", "http://www.afternet.org");
618 "body_suffix" ("", "AfterNET IRC Network", "http://www.afternet.org", "support@afternet.org","irc://irc.afternet.org/afternet");
619 };
620
621 /* DBS (Databases) *************************************************
622 * let you configure what databases go in what files.
623 *
624 * This default sets up everything in one big x3.db file.
625 *
626 * If you leave this section out, each database will be in its own file,
627 * and they will be written out every half hour.
628 */
629 "dbs" {
630 // This just illustrates how you can jam every database into one huge ("mondo") file.
631 "ChanServ" { "mondo_section" "ChanServ"; };
632 "gline" { "mondo_section" "gline"; };
633 "shun" { "mondo_section" "shun"; };
634 "Global" { "mondo_section" "Global"; };
635 "HelpServ" { "mondo_section" "HelpServ"; };
636 "modcmd" { "mondo_section" "modcmd"; };
637 "NickServ" { "mondo_section" "NickServ"; };
638 "OpServ" { "mondo_section" "OpServ"; };
639 "sendmail" { "mondo_section" "sendmail"; };
640 "SpamServ" { "mondo_section" "SpamServ"; };
641
642 // These are the options if you want a database to be in its own file.
643 "mondo" {
644 // Where to put it?
645 "filename" "x3.db";
646 // How often should it be saved?
647 // (You can disable automatic saves by setting this to 0.)
648 "frequency" "30m";
649 };
650 };
651
652 /* LOGS (If and how X3 logs data ) ***********************************
653 * LOGS sets up where X3 logs various kinds of info to.
654 */
655 "logs" {
656 // Two kinds of items exist in this section.
657
658 // One is a facility configuration subsection. These have the
659 // name of a log facility (one of "ChanServ", "Global",
660 // "HelpServ", "NickServ", "OpServ", "ProxyCheck", or "x3") and
661 // the value is a subsection. The "x3" log facility is a
662 // catch-all/fall-back facility.
663 "x3" {
664 // The "max_age" option says how long to keep log audit entries.
665 "max_age" "10h";
666 // The "max_count" option says how many log audit entries to keep.
667 "max_count" "1024";
668 // Audit (command tracking) entries are discarded if they exceed
669 // either limit: for example, if entry 500 is 10 minutes old, it
670 // will be discarded next time any audit command is logged.
671 };
672
673 // The other kind of item is a target list. The name of each is a
674 // description of facility-and-severity combinations, and the value
675 // is a string (or list of strings) that describe where matching
676 // events should be logged. As a special case, the facility * will
677 // specify how to log events regardless of their true facility, and
678 // the severity * will match all severities for a facility.
679 // Log targets use a psuedo-URI syntax: one of "file:filename",
680 // "std:[out|err|n]" where n is a valid file descriptor, or
681 // "irc:#channel" (nicknames or server masks can be used instead
682 // of channel names, but should be used with care).
683 // The severity is one of "replay", "debug", "command", "info",
684 // "override", "staff", "warning", "error", or "fatal".
685 // WARNING: If any severity except "replay" for a facility is left
686 // unspecified, it will use the default target (for example,
687 // "file:chanserv.log"). For "replay" severity, you must ALWAYS
688 // list a target to log it -- this is because it is very rarely
689 // useful.
690 "*.*" ("std:out", "file:everything.log"); // does NOT suppress any defaults
691 "*.override,error,fatal" "irc:#TheOps"; // report all uses of staff commands
692 "*.staff" "irc:#MrSnoopy"; // report all uses of staff commands
693 "ChanServ.*" "file:chanserv.log"; // duplicates the default behavior
694 "ProxyCheck.*" (); // stop it from logging anything
695 };