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