1 // services configuration file (example)
2 /* It allows two kinds of comments. Whitespaces between tokens are
3 * ignored. All strings (even if they're just numbers) MUST be
4 * enclosed in double quotes. There must be a semicolon after every
8 // The "uplinks" section describes what servers we can possibly link
9 // to. Each subsection describes one server.
12 // IP address and port the server listens on
15 // What password should we send when we connect?
16 "password" "passwordtoconnect";
17 // What password should we require our peer to send?
18 // (If it is blank, we do not require a specific password.)
19 "their_password" "passwordtorequire";
21 // How many times should we try to connect before giving up?
23 // What IP should we bind to?
24 // If you do not specify bind_address, the default is used.
25 // "bind_address" "192.168.0.10"; // use this ip to link
28 /* unused-uplink is just an example to show you how you can
29 * define more than one uplink (and how you can disable one or
34 "password" "passwordtoconnect";
35 "their_password" "passwordtorequire";
36 // If "enabled" is 0, we will not try to use this uplink.
42 // The "services" section configures the services that make up srvx.
46 // What user modes do you want this service to have? Please keep in
47 // mind which ircd software you are using here, and that all of the
48 // services need to be at least +o.
50 // If you want to by have *@* as the default hostmask for all
51 // new accounts, set default_hostmask. This is discouraged
52 // for security reasons.
53 // "default_hostmask" "1";
54 // do we warn users when someone new auths to their account?
55 "warn_clone_auth" "1";
56 // what is the default maxlogins value?
57 "default_maxlogins" "2";
58 // what is the absolute maxlogins value?
59 "hard_maxlogins" "10";
60 // Which mode should we use for account timestamps?
61 "account_timestamp_mode" "ignore";
62 // This names a file that contains easily guessed passwords.
63 // It always contains "password", "<password>" and the user's
65 "dict_file" "/usr/share/dict/words";
66 // Minimum number of various types of characters permitted in
68 "password_min_length" "4";
69 "password_min_digits" "1";
70 "password_min_upper" "0";
71 "password_min_lower" "0";
72 // What should valid account and nicks look like?
73 // If valid_nick_regex is omitted, valid_account_regex is used
74 // for both nicks and accounts.
75 // These look funny because "[][-]" is the only way to write the
76 // character class containing the characters ']', '[' and '-'.
77 "valid_account_regex" "^[][_a-z^`'{}|-][][_a-z0-9^`'{}|-]*$";
78 "valid_nick_regex" "^[-_a-z][-_a-z0-9]*$";
80 // Should nick ownership be disabled?
82 // One account may only own this many nicks.
83 "nicks_per_account" "4";
84 // Send a warning when someone uses a registered nick?
85 "warn_nick_owned" "0";
86 // What to do when someone uses the NickServ "reclaim" command?
87 // This can be one of "none", "warn", "svsnick", or "kill", but
88 // stock ircu does not support svsnick -- you need Bahamut or a
89 // patch for ircu. no, don't ask srvx developers for the patch.
90 "reclaim_action" "none";
91 // What (else) to do when someone uses a registered nick?
92 // This can be anything "reclaim_action" can be, but it makes
93 // more sense to use the "warn_nick_owned" instead of "warn".
94 "auto_reclaim_action" "none";
95 // How long to wait before doing the auto_reclaim_action?
96 // This is ignored if "auto_reclaim_action" is "none".
97 "auto_reclaim_delay" "0";
99 // access control for who can change account flags
102 "lc_h" "800"; // specifically lower case h
103 "uc_H" "800"; // .. and upper case H
108 // and for who can change epithets for staff
109 "set_epithet_level" "800";
110 // what opserv access level do you need to set somebody else's level?
111 "modoper_level" "850";
112 // what opserv access level do you need to set somebody's staff level?
113 "modstaff_level" "750";
115 // how often should accounts be expired?
116 "account_expire_freq" "1d";
117 // how long until an account with access to any channel(s) expires?
118 "account_expire_delay" "35d";
119 // how long until an account with no access to any channels expires?
120 "nochan_account_expire_delay" "14d";
121 // how long must an account be inactive so it can be ounregistered without force?
122 "ounregister_inactive" "1M";
123 // which flags on an account require the ounregister to be used with force?
124 "ounregister_flags" "ShgsfnHbuI";
125 /* "require_qualified" has been removed. It is now
126 * integrated into the modcmd command authorization
127 * and dispatch mechanism. "/msg OpServ help modcmd"
130 // If somebody keeps guessing passwords incorrectly, do we gag them?
131 "autogag_enabled" "1";
132 "autogag_duration" "30m";
137 // How to integrate with email cookies?
138 "email_enabled" "0"; // if set, /mail/enable MUST be set too
139 "email_required" "0"; // ignored unless email_enabled is non-zero
140 "cookie_timeout" "1d"; // how long before we expire cookies?
141 "accounts_per_email" "1"; // you may want to increase this; or not
142 "email_search_level" "600"; // minimum OpServ level to search based on email address
143 "email_visible_level" "800"; // minimum OpServ level to see somebody's email address
148 // What user modes do you want this service to have? Please keep in
149 // mind which ircd software you are using here, and that all of the
150 // services need to be at least +o.
152 // should use of this service be limited to global opers?
154 // fullname for service
155 "description" "Oper Service Bot";
156 // hostname for service; only used if "description" is also set
157 "hostname" "dances-all-night-with.srvx.net";
158 // what channel should opserv send debug output to?
159 "debug_channel" "#opserv";
160 "debug_channel_modes" "+tinms";
161 // where to send general alerts (e.g. flood alerts)?
162 "alert_channel" "#ircops";
163 "alert_channel_modes" "+tns";
164 // who to tell about staff auths?
165 "staff_auth_channel" "#opserv";
166 "staff_auth_channel_modes" "+tinms";
167 // Force Opers to be in staff_auth_channel
168 // 0 = don't force opers to be in the channel
169 // 1 = force opers to be in the channel
170 // 2 = force opers to be in the channel but kick them if they get mode -o set (deoper)
171 "staff_auth_force_opers" "2";
172 // how many clones to allow from an untrusted host?
174 // how long of a g-line should be issued if the max hosts is exceeded?
175 "clone_gline_duration" "1h";
176 // how long to g-line for ?block (or, by default, for ?trace gline)?
177 "block_gline_duration" "1h";
178 // how long to keep an illegal channel locked down (seconds)?
179 "purge_lock_delay" "60";
180 // channel join flood policer params?
185 // automatically moderate join flooded channels?
186 "join_flood_moderate" "1";
187 // Don't moderate and warn channels unless there are more than
188 // join_flood_moderate_threshold users in the channel. the
189 // value 0 will disable the threshold.
190 "join_flood_moderate_threshold" "50";
191 // new user flood policer params
200 // You may disable a service by removing its "nick" config item.
201 // That means: SERVICES WILL ONLY WORK IF YOU DEFINE THEIR NICK.
202 // (This is changed relative srvx-1.0.x, which would use default
203 // unless you specified ".disabled".)
205 // What user modes do you want this service to have? Please keep in
206 // mind which ircd software you are using here, and that all of the
207 // services need to be at least +o.
209 // Does your ircd have off-channel services support? Does it have
210 // a registered channel mode? Does it support services opping themselves?
211 // Bahamut has these things; ircu2.10.11 does not.
212 // This setting takes three numerical values:
214 // 1 = use a registered channel mode, have services op themselves
215 // 2 = all of the above, and a channel setting to have ChanServ not
216 // idle in the channel
218 // revoke channel mode +a on unregister?
220 // how long should a person be unseen before resending infoline?
222 // maximum greeting length
223 "max_greetlen" "200";
224 // maximum users in a channel userlist
225 "max_chan_users" "512";
226 // maximum bans on a channel banlist
227 "max_chan_bans" "512";
228 // maximum length of a user's infoline
229 "max_userinfo_length" "400";
230 // If DynLimit is on and there are N users in the channel, ChanServ will
231 // try to keep the limit at N+<adjust_threshold>.
232 "adjust_threshold" "15";
233 // .. but ChanServ will only increment or decrement the limit this often.
235 // How often to look for channels that have expired?
236 "chan_expire_freq" "3d";
237 // How long is a channel unvisited (by masters or above) before it can be expired?
238 "chan_expire_delay" "30d";
239 // How often to look for dnrs that have expired?
240 "dnr_expire_freq" "1h";
241 // what !set options should we show when user calls "!set" with no arguments?
242 "set_shows" ("DefaultTopic", "TopicMask", "AdvTopic", "Greeting", "UserGreeting", "Modes", "PubCmd", "InviteMe", "EnfModes", "EnfTopic", "TopicSnarf", "UserInfo", "GiveVoice", "GiveOps", "EnfOps", "Setters", "CtcpUsers", "CtcpReaction", "Protect", "Toys", "DynLimit", "NoDelete");
244 // A list of !8ball responses
245 "8ball" ("Not a chance.",
248 "Could be, could be.");
249 // channel(s) that support helpers must be in to be helping
250 // if this is a list, any one by itself will do
251 "support_channel" ("#support", "#registration");
252 // maximum number of channels owned by one account before FORCE is required
254 // how long between automatic topic refreshes with TopicRefresh 0
255 "refresh_period" "3h";
256 // how long between two invites of an user
257 "invite_timeout" "10s";
258 // what should !access say for various staff?
259 "irc_operator_epithet" "a megalomaniacal power hungry tyrant";
260 "network_helper_epithet" "a wannabe tyrant";
261 "support_helper_epithet" "a wannabe tyrant";
262 // what should a newly registered channel get as its modes?
263 "default_modes" "+nt";
264 // minimum opserv access to set, clear or override nodelete setting?
265 "nodelete_level" "1";
266 // how long before a new channel owner can give ownership away?
267 "giveownership_timeout" "1w";
268 // message sent to new channels
269 "new_channel_unauthed_join" ""; //only sent if the user is unauthed
270 "new_channel_authed_join" ""; //only sent if the user is authed
271 "new_channel_message" ""; //always after the message above
277 // What user modes do you want this service to have? Please keep in
278 // mind which ircd software you are using here, and that all of the
279 // services need to be at least +o.
281 // should users get community announcements by default or not?
282 "announcements_default" "on";
286 // You may disable a service by removing its "nick" config item.
287 // That means: SERVICES WILL ONLY WORK IF YOU DEFINE THEIR NICK.
288 // (This is changed relative srvx-1.0.x, which would use default
289 // unless you specified ".disabled".)
291 "debug_channel" "#spamserv";
292 // url of the network rules. if you don't have network rules, remove this key.
293 "network_rules" "http://www.gamesurge.net/aup";
294 // trigger for spamserv; remove this key to disable the trigger
296 // ban duration of a short timedban.
297 "short_ban_duration" "15m";
298 // ban duration of a long timedban.
299 "long_ban_duration" "1h";
300 // duration of a gline. SpamServ will issue it after several violations and a kill.
301 "gline_duration" "1h";
302 // users may add "exception_max" exceptions to the list. IRCOps can override "exception_max".
303 "exception_max" "10";
304 // minimum & maximum length of an exception.
305 "exception_min_len" "4";
306 "exception_max_len" "12";
307 // if someone advertises a channel, which doesn't exist (channel is empty, no users),
308 // SpamServ doesn't punish the user.
309 // enable this setting, if SpamServ has to ignore advertisements of channels, which do not exist.
310 // disable this setting, if SpamServ has to punish the users whenever they advertise.
311 "adv_chan_must_exist" "0";
312 // remove all mirc codes from messages before checking for advertisements.
313 // if this setting is disabled and someone spams a url which
314 // contains a bold char, SpamServ doesn't punish him.
315 "strip_mirc_codes" "1";
316 // enable this, if SpamServ has to "follow" ChanServ, when a channel moves or merges.
317 // disable it, if it shouldn't be possible to move or merge SpamServ with /msg chanserv move|merge.
318 "allow_move_merge" "1";
322 // The modules section gives configuration information to optional modules.
325 // The description/fullname field
326 "description" "Help Queue Manager";
327 // HelpServ bots log all of their requests to this file, with
328 // details on when they were opened, closed, their contents,
329 // helper, etc. The file is written in saxdb format for easy
330 // parsing by external programs. Please note that you cannot
331 // use ?set to change this value while srvx is running.
332 "reqlogfile" "helpservreq.log";
333 // How long should a helpserv be inactive (no requests assigned)
334 // before it can be unregistered by the expire command?
338 "max_sockets" "64"; // allow 64 concurrent clients to be checked
339 "max_read" "1024"; // don't read more than 1024 bytes from any client
340 "gline_duration" "1h"; // issue G-lines lasting one hour
341 "max_cache_age" "60"; // only cache results for 60 seconds
342 // "bind_address" "192.168.0.10"; // do proxy tests from this address
345 // Where to send snoop messages?
346 "channel" "#wherever";
349 // Show new users and joins from net joins? (off by default)
354 "message_expiry" "30d"; // age when messages are deleted; set
355 // to 0 to disable message expiration
358 "bind_address" "127.0.0.1";
363 // File containing blacklisted client addresses.
364 // "file" "blacklist.txt";
365 // Each line in the file should start with an IP or hostname.
366 // If there is whitespace and a message after that, the
367 // message will override this one:
368 "file_reason" "client is blacklisted";
369 // How long should a blacklist G-line last?
370 "gline_duration" "1h";
371 // Bot used to send debug notices
372 "debug_bot" "OpServ";
373 // To which channel should debug output be sent?
374 "debug_channel" "#opserv";
375 "debug_channel_modes" "+tinms";
376 // If you want to use DNS blacklists, add them here:
378 // This DNSBL zone does not exist - you'll have to pick your own.
379 "dnsbl.example.org" {
380 // Send a notice instead of glining blacklisted ips
382 "description" "Example DNSBL entry";
383 "reason" "busted by a dns blacklist";
385 // You can stick the client's IP in the G-line message.
386 "reason_2" "Example DNSBL reported %ip%'s address as 127.0.0.2";
387 // .. or the contents of a DNS TXT.
393 // You generally will not want to override these defaults.
394 // "resolv_conf" "/etc/resolv.conf";
395 // "services" "/etc/services";
396 // "bind_address" "0.0.0.0";
398 // The defaults for these are derived from the system config files (above).
399 // "domain" "example.org";
400 // "timeout" "3"; // base timeout for a DNS reply
401 // "retries" "3"; // number of times to retry on different servers or longer timeouts
402 // "ndots" "1"; // number of dots needed in a hostname to bypass search path
403 // "edns0" "0"; // if set, enable EDNS0 extended message sizes
404 // "search" ("example.org", "example.net");
405 // "nameservers" ("127.0.0.1");
410 "ban_duration" "2h"; //only if the channel is registered with chanserv
411 "gline_duration" "1h";
412 "punishment_reason" "Your message contained a forbidden word.";
430 "hostname" "localhost.domain";
431 "description" "Network Services";
432 "network" "GenericNET";
433 "hidden_host" "users.Generic.NET"; // set this if you enabled ircd/Undernet's +x mode
434 /* hidden_host should match the F:HIDDEN_HOST: line in your ircu's ircd.conf;
435 * srvx does not set the host suffix for users, but must know it when making
436 * things like bans, where it should not show the user's real hostname. */
437 "numeric" "10"; // hint: If you get collisions on link, CHANGE THIS.
438 "max_users" "256"; // You can save a little memory by setting this to a lower value.
439 "force_n2k" "1"; // Use extended (5-digit) numnick for self, even if 3 are possible.
442 "max_cycles" "30"; // max uplink cycles before giving up
443 // Admin information is traditionally: location, location, email
444 "admin" ("IRC Network", "Gotham City, GO", "Mr Commissioner <james.gordon@police.gov>");
445 /* the following two settings are for ircu's HEAD_IN_SAND features, and are equivelent to
446 * the F: lines in ircu's ircd.conf. both can be disabled by commenting them out. */
447 "his_servername" "*.Generic.NET"; // hidden server name, shown in remote /whois requests
448 "his_servercomment" "The Generic, Boring IRC Network";
451 // controlling how services (mostly NickServ) send mail
453 // These options are the defaults.
455 "mailer" "/usr/sbin/sendmail";
456 "from_address" "admin@poorly.configured.server";
458 "extra_headers" ("X-Ereet-Services: srvx r reet");
459 "body_prefix_first" ("Welcome to our network. This prefix is used whenever srvx thinks this may be the first time we send email to your address.");
460 "body_prefix" ("This goes before the mail text.", "Each string here is treated as a separate \"paragraph\" for line wrapping.");
461 "body_suffix_first" ("We care a lot about spam. If you did not request this email, bitch and moan loudly at our opers, and tell our ISP to gank our connection.");
462 "body_suffix" ("PLEASE DO NOT BE ALARMED. CALMLY BOARD THE AIRCRAFT, STRAP YOUR ARMS ACROSS YOUR BODY, AND JUMP THE HELL OUT OF THE PLANE.", "Yaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaatta!");
463 // If you are using the smtp mail back-end, you may need to set these:
464 "smtp_server" "localhost";
465 "smtp_service" "smtp";
466 // "smtp_myname" "localhost.domain";
469 // New section in srvx-1.2 to control database locations, etc.
470 // If you leave this section out, each database will be in its own file,
471 // and they will be written out every half hour.
473 // This just illustrates how you can jam every database into one huge ("mondo") file.
474 "ChanServ" { "mondo_section" "ChanServ"; };
475 "gline" { "mondo_section" "gline"; };
476 "Global" { "mondo_section" "Global"; };
477 "HelpServ" { "mondo_section" "HelpServ"; };
478 "modcmd" { "mondo_section" "modcmd"; };
479 "NickServ" { "mondo_section" "NickServ"; };
480 "OpServ" { "mondo_section" "OpServ"; };
481 "sendmail" { "mondo_section" "sendmail"; };
482 "SpamServ" { "mondo_section" "SpamServ"; };
483 "Watchdog" { "mondo_section" "Watchdog"; };
485 // These are the options if you want a database to be in its own file.
488 "filename" "srvx.db";
489 // How often should it be saved?
490 // (You can disable automatic saves by setting this to 0.)
495 // New section in srvx-1.2 to control log destinations.
496 // If you leave this section out, each service (technically, each log
497 // facility) will be in its own file, just like before.
499 // Two kinds of items exist in this section.
501 // One is a facility configuration subsection. These have the
502 // name of a log facility (one of "ChanServ", "Global",
503 // "HelpServ", "NickServ", "OpServ", "ProxyCheck", or "srvx") and
504 // the value is a subsection. The "srvx" log facility is a
505 // catch-all/fall-back facility.
507 // The "max_age" option says how long to keep log audit entries.
509 // The "max_count" option says how many log audit entries to keep.
511 // Audit (command tracking) entries are discarded if they exceed
512 // either limit: for example, if entry 500 is 10 minutes old, it
513 // will be discarded next time any audit command is logged.
516 // The other kind of item is a target list. The name of each is a
517 // description of facility-and-severity combinations, and the value
518 // is a string (or list of strings) that describe where matching
519 // events should be logged. As a special case, the facility * will
520 // specify how to log events regardless of their true facility, and
521 // the severity * will match all severities for a facility.
522 // Log targets use a psuedo-URI syntax: one of "file:filename",
523 // "std:[out|err|n]" where n is a valid file descriptor, or
524 // "irc:#channel" (nicknames or server masks can be used instead
525 // of channel names, but should be used with care).
526 // The severity is one of "replay", "debug", "command", "info",
527 // "override", "staff", "warning", "error", or "fatal".
528 // WARNING: If any severity except "replay" for a facility is left
529 // unspecified, it will use the default target (for example,
530 // "file:chanserv.log"). For "replay" severity, you must ALWAYS
531 // list a target to log it -- this is because it is very rarely
533 "*.*" ("std:out", "file:everything.log"); // does NOT suppress any defaults
534 "*.override,staff" "irc:#big-brother"; // report all uses of staff commands
535 "ChanServ.*" "file:chanserv.log"; // duplicates the default behavior
536 "ProxyCheck.*" (); // stop it from logging anything