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