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