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