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