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 // This names a file that contains easily guessed passwords.
61 // It always contains "password", "<password>" and the user's
63 "dict_file" "/usr/share/dict/words";
64 // Minimum number of various types of characters permitted in
66 "password_min_length" "4";
67 "password_min_digits" "1";
68 "password_min_upper" "0";
69 "password_min_lower" "0";
70 // What should valid account and nicks look like?
71 // If valid_nick_regex is omitted, valid_account_regex is used
72 // for both nicks and accounts.
73 // These look funny because "[][-]" is the only way to write the
74 // character class containing the characters ']', '[' and '-'.
75 "valid_account_regex" "^[][_a-z^`'{}|-][][_a-z0-9^`'{}|-]*$";
76 "valid_nick_regex" "^[-_a-z][-_a-z0-9]*$";
78 // Should nick ownership be disabled?
80 // One account may only own this many nicks.
81 "nicks_per_account" "4";
82 // Send a warning when someone uses a registered nick?
83 "warn_nick_owned" "0";
84 // What to do when someone uses the NickServ "reclaim" command?
85 // This can be one of "none", "warn", "svsnick", or "kill", but
86 // stock ircu does not support svsnick -- you need Bahamut or a
87 // patch for ircu. no, don't ask srvx developers for the patch.
88 "reclaim_action" "none";
89 // What (else) to do when someone uses a registered nick?
90 // This can be anything "reclaim_action" can be, but it makes
91 // more sense to use the "warn_nick_owned" instead of "warn".
92 "auto_reclaim_action" "none";
93 // How long to wait before doing the auto_reclaim_action?
94 // This is ignored if "auto_reclaim_action" is "none".
95 "auto_reclaim_delay" "0";
97 // access control for who can change account flags
100 "lc_h" "800"; // specifically lower case h
101 "uc_H" "800"; // .. and upper case H
105 // and for who can change epithets for staff
106 "set_epithet_level" "800";
107 // what opserv access level do you need to set somebody else's level?
108 "modoper_level" "850";
110 // how often should accounts be expired?
111 "account_expire_freq" "1d";
112 // how long until an account with access to any channel(s) expires?
113 "account_expire_delay" "35d";
114 // how long until an account with no access to any channels expires?
115 "nochan_account_expire_delay" "14d";
116 // how long must an account be inactive so it can be ounregistered without force?
117 "ounregister_inactive" "1M";
118 // which flags on an account require the ounregister to be used with force?
119 "ounregister_flags" "ShgsfnHbu";
120 /* "require_qualified" has been removed. It is now
121 * integrated into the modcmd command authorization
122 * and dispatch mechanism. "/msg OpServ help modcmd"
125 // If somebody keeps guessing passwords incorrectly, do we gag them?
126 "autogag_enabled" "1";
127 "autogag_duration" "30m";
132 // How to integrate with email cookies?
133 "email_enabled" "0"; // if set, /mail/enable MUST be set too
134 "email_required" "0"; // ignored unless email_enabled is non-zero
135 "cookie_timeout" "1d"; // how long before we expire cookies?
136 "accounts_per_email" "1"; // you may want to increase this; or not
137 "email_search_level" "600"; // minimum OpServ level to search based on email address
138 "email_visible_level" "800"; // minimum OpServ level to see somebody's email address
143 // What user modes do you want this service to have? Please keep in
144 // mind which ircd software you are using here, and that all of the
145 // services need to be at least +o.
147 // should use of this service be limited to global opers?
149 // fullname for service
150 "description" "Oper Service Bot";
151 // hostname for service; only used if "description" is also set
152 "hostname" "dances-all-night-with.srvx.net";
153 // what channel should opserv send debug output to?
154 "debug_channel" "#opserv";
155 "debug_channel_modes" "+tinms";
156 // where to send general alerts (e.g. flood alerts)?
157 "alert_channel" "#ircops";
158 "alert_channel_modes" "+tns";
159 // who to tell about staff auths?
160 "staff_auth_channel" "#opserv";
161 "staff_auth_channel_modes" "+tinms";
162 // how many clones to allow from an untrusted host?
164 // how long of a g-line should be issued if the max hosts is exceeded?
165 "clone_gline_duration" "1h";
166 // how long to g-line for ?block (or, by default, for ?trace gline)?
167 "block_gline_duration" "1h";
168 // how long to keep an illegal channel locked down (seconds)?
169 "purge_lock_delay" "60";
170 // channel join flood policer params?
175 // automatically moderate join flooded channels?
176 "join_flood_moderate" "1";
177 // Don't moderate and warn channels unless there are more than
178 // join_flood_moderate_threshold users in the channel. the
179 // value 0 will disable the threshold.
180 "join_flood_moderate_threshold" "50";
181 // new user flood policer params
189 // You may disable a service by removing its "nick" config item.
190 // That means: SERVICES WILL ONLY WORK IF YOU DEFINE THEIR NICK.
191 // (This is changed relative srvx-1.0.x, which would use default
192 // unless you specified ".disabled".)
194 // What user modes do you want this service to have? Please keep in
195 // mind which ircd software you are using here, and that all of the
196 // services need to be at least +o.
198 // Does your ircd have off-channel services support? Does it have
199 // a registered channel mode? Does it support services opping themselves?
200 // Bahamut has these things; ircu2.10.11 does not.
201 // This setting takes three numerical values:
203 // 1 = use a registered channel mode, have services op themselves
204 // 2 = all of the above, and a channel setting to have ChanServ not
205 // idle in the channel
207 // how long should a person be unseen before resending infoline?
209 // maximum greeting length
210 "max_greetlen" "200";
211 // maximum users in a channel userlist
212 "max_chan_users" "512";
213 // maximum bans on a channel banlist
214 "max_chan_bans" "512";
215 // maximum length of a user's infoline
216 "max_userinfo_length" "400";
217 // If DynLimit is on and there are N users in the channel, ChanServ will
218 // try to keep the limit at N+<adjust_threshold>.
219 "adjust_threshold" "15";
220 // .. but ChanServ will only increment or decrement the limit this often.
222 // How often to look for channels that have expired?
223 "chan_expire_freq" "3d";
224 // How long is a channel unvisited (by masters or above) before it can be expired?
225 "chan_expire_delay" "30d";
226 // How often to look for dnrs that have expired?
227 "dnr_expire_freq" "1h";
228 // what !set options should we show when user calls "!set" with no arguments?
229 "set_shows" ("DefaultTopic", "TopicMask", "Greeting", "UserGreeting", "Modes", "PubCmd", "InviteMe", "StrictOp", "AutoOp", "EnfModes", "EnfTopic", "TopicSnarf", "UserInfo", "GiveVoice", "GiveOps", "EnfOps", "Setters", "CtcpUser", "CtcpReaction", "Protect", "Toys", "DynLimit", "NoDelete");
231 // A list of !8ball responses
232 "8ball" ("Not a chance.",
235 "Could be, could be.");
236 // channel(s) that support helpers must be in to be helping
237 // if this is a list, any one by itself will do
238 "support_channel" ("#support", "#registration");
239 // maximum number of channels owned by one account before FORCE is required
241 // how long between automatic topic refreshes with TopicRefresh 0
242 "refresh_period" "3h";
243 // what should !access say for various staff?
244 "irc_operator_epithet" "a megalomaniacal power hungry tyrant";
245 "network_helper_epithet" "a wannabe tyrant";
246 "support_helper_epithet" "a wannabe tyrant";
247 // what should a newly registered channel get as its modes?
248 "default_modes" "+nt";
249 // minimum opserv access to set, clear or override nodelete setting?
250 "nodelete_level" "1";
251 // how long before a new channel owner can give ownership away?
252 "giveownership_timeout" "1w";
257 // What user modes do you want this service to have? Please keep in
258 // mind which ircd software you are using here, and that all of the
259 // services need to be at least +o.
261 // should users get community announcements by default or not?
262 "announcements_default" "on";
266 // The modules section gives configuration information to optional modules.
269 // The description/fullname field
270 "description" "Help Queue Manager";
271 // HelpServ bots log all of their requests to this file, with
272 // details on when they were opened, closed, their contents,
273 // helper, etc. The file is written in saxdb format for easy
274 // parsing by external programs. Please note that you cannot
275 // use ?set to change this value while srvx is running.
276 "reqlogfile" "helpservreq.log";
277 // How long should a helpserv be inactive (no requests assigned)
278 // before it can be unregistered by the expire command?
282 "max_sockets" "64"; // allow 64 concurrent clients to be checked
283 "max_read" "1024"; // don't read more than 1024 bytes from any client
284 "gline_duration" "1h"; // issue G-lines lasting one hour
285 "max_cache_age" "60"; // only cache results for 60 seconds
286 // "bind_address" "192.168.0.10"; // do proxy tests from this address
289 // Where to send snoop messages?
290 "channel" "#wherever";
293 // Show new users and joins from net joins? (off by default)
298 "message_expiry" "30d"; // age when messages are deleted; set
299 // to 0 to disable message expiration
302 "bind_address" "127.0.0.1";
307 // File containing blacklisted client addresses.
308 // "file" "blacklist.txt";
309 // Each line in the file should start with an IP or hostname.
310 // If there is whitespace and a message after that, the
311 // message will override this one:
312 "file_reason" "client is blacklisted";
313 // How long should a blacklist G-line last?
314 "gline_duration" "1h";
315 // Bot used to send debug notices
316 "debug_bot" "OpServ";
317 // To which channel should debug output be sent?
318 "debug_channel" "#opserv";
319 "debug_channel_modes" "+tinms";
320 // If you want to use DNS blacklists, add them here:
322 // This DNSBL zone does not exist - you'll have to pick your own.
323 "dnsbl.example.org" {
324 // Send a notice instead of glining blacklisted ips
326 "description" "Example DNSBL entry";
327 "reason" "busted by a dns blacklist";
329 // You can stick the client's IP in the G-line message.
330 "reason_2" "Example DNSBL reported %ip%'s address as 127.0.0.2";
331 // .. or the contents of a DNS TXT.
337 // You generally will not want to override these defaults.
338 // "resolv_conf" "/etc/resolv.conf";
339 // "services" "/etc/services";
340 // "bind_address" "0.0.0.0";
342 // The defaults for these are derived from the system config files (above).
343 // "domain" "example.org";
344 // "timeout" "3"; // base timeout for a DNS reply
345 // "retries" "3"; // number of times to retry on different servers or longer timeouts
346 // "ndots" "1"; // number of dots needed in a hostname to bypass search path
347 // "edns0" "0"; // if set, enable EDNS0 extended message sizes
348 // "search" ("example.org", "example.net");
349 // "nameservers" ("127.0.0.1");
367 "hostname" "localhost.domain";
368 "description" "Network Services";
369 "network" "GenericNET";
370 "hidden_host" "users.Generic.NET"; // set this if you enabled ircd/Undernet's +x mode
371 /* hidden_host should match the F:HIDDEN_HOST: line in your ircu's ircd.conf;
372 * srvx does not set the host suffix for users, but must know it when making
373 * things like bans, where it should not show the user's real hostname. */
374 "numeric" "10"; // hint: If you get collisions on link, CHANGE THIS.
375 "max_users" "256"; // You can save a little memory by setting this to a lower value.
376 "force_n2k" "1"; // Use extended (5-digit) numnick for self, even if 3 are possible.
379 "max_cycles" "30"; // max uplink cycles before giving up
380 // Admin information is traditionally: location, location, email
381 "admin" ("IRC Network", "Gotham City, GO", "Mr Commissioner <james.gordon@police.gov>");
382 /* the following two settings are for ircu's HEAD_IN_SAND features, and are equivelent to
383 * the F: lines in ircu's ircd.conf. both can be disabled by commenting them out. */
384 "his_servername" "*.Generic.NET"; // hidden server name, shown in remote /whois requests
385 "his_servercomment" "The Generic, Boring IRC Network";
388 // controlling how services (mostly NickServ) send mail
390 // These options are the defaults.
392 "mailer" "/usr/sbin/sendmail";
393 "from_address" "admin@poorly.configured.server";
395 "extra_headers" ("X-Ereet-Services: srvx r reet");
396 "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.");
397 "body_prefix" ("This goes before the mail text.", "Each string here is treated as a separate \"paragraph\" for line wrapping.");
398 "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.");
399 "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!");
402 // New section in srvx-1.2 to control database locations, etc.
403 // If you leave this section out, each database will be in its own file,
404 // and they will be written out every half hour.
406 // This just illustrates how you can jam every database into one huge ("mondo") file.
407 "ChanServ" { "mondo_section" "ChanServ"; };
408 "gline" { "mondo_section" "gline"; };
409 "Global" { "mondo_section" "Global"; };
410 "HelpServ" { "mondo_section" "HelpServ"; };
411 "modcmd" { "mondo_section" "modcmd"; };
412 "NickServ" { "mondo_section" "NickServ"; };
413 "OpServ" { "mondo_section" "OpServ"; };
414 "sendmail" { "mondo_section" "sendmail"; };
416 // These are the options if you want a database to be in its own file.
419 "filename" "srvx.db";
420 // How often should it be saved?
421 // (You can disable automatic saves by setting this to 0.)
426 // New section in srvx-1.2 to control log destinations.
427 // If you leave this section out, each service (technically, each log
428 // facility) will be in its own file, just like before.
430 // Two kinds of items exist in this section.
432 // One is a facility configuration subsection. These have the
433 // name of a log facility (one of "ChanServ", "Global",
434 // "HelpServ", "NickServ", "OpServ", "ProxyCheck", or "srvx") and
435 // the value is a subsection. The "srvx" log facility is a
436 // catch-all/fall-back facility.
438 // The "max_age" option says how long to keep log audit entries.
440 // The "max_count" option says how many log audit entries to keep.
442 // Audit (command tracking) entries are discarded if they exceed
443 // either limit: for example, if entry 500 is 10 minutes old, it
444 // will be discarded next time any audit command is logged.
447 // The other kind of item is a target list. The name of each is a
448 // description of facility-and-severity combinations, and the value
449 // is a string (or list of strings) that describe where matching
450 // events should be logged. As a special case, the facility * will
451 // specify how to log events regardless of their true facility, and
452 // the severity * will match all severities for a facility.
453 // Log targets use a psuedo-URI syntax: one of "file:filename",
454 // "std:[out|err|n]" where n is a valid file descriptor, or
455 // "irc:#channel" (nicknames or server masks can be used instead
456 // of channel names, but should be used with care).
457 // The severity is one of "replay", "debug", "command", "info",
458 // "override", "staff", "warning", "error", or "fatal".
459 // WARNING: If any severity except "replay" for a facility is left
460 // unspecified, it will use the default target (for example,
461 // "file:chanserv.log"). For "replay" severity, you must ALWAYS
462 // list a target to log it -- this is because it is very rarely
464 "*.*" ("std:out", "file:everything.log"); // does NOT suppress any defaults
465 "*.override,staff" "irc:#big-brother"; // report all uses of staff commands
466 "ChanServ.*" "file:chanserv.log"; // duplicates the default behavior
467 "ProxyCheck.*" (); // stop it from logging anything