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