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