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