]>
Commit | Line | Data |
---|---|---|
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 | |
5 | * key/value pair. | |
6 | */ | |
7 | ||
8 | // The "uplinks" section describes what servers we can possibly link | |
9 | // to. Each subsection describes one server. | |
10 | "uplinks" { | |
11 | "private-network" { | |
12 | // IP address and port the server listens on | |
13 | "address" "10.0.0.3"; | |
14 | "port" "6660"; | |
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"; | |
20 | "enabled" "1"; | |
21 | // How many times should we try to connect before giving up? | |
22 | "max_tries" "3"; | |
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 | |
26 | }; | |
27 | ||
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 | |
30 | * more of them.) */ | |
31 | "unused-uplink" { | |
32 | "address" "10.0.0.4"; | |
33 | "port" "6660"; | |
34 | "password" "passwordtoconnect"; | |
35 | "their_password" "passwordtorequire"; | |
36 | // If "enabled" is 0, we will not try to use this uplink. | |
37 | "enabled" "0"; | |
38 | "max_tries" "3"; | |
39 | }; | |
40 | }; | |
41 | ||
42 | // The "services" section configures the services that make up srvx. | |
43 | "services" { | |
44 | "nickserv" { | |
45 | "nick" "NickServ"; | |
46 | // If you want to by have *@* as the default hostmask, set | |
47 | // default_hostmask. This is discouraged for security reasons. | |
48 | // "default_hostmask" "1"; | |
49 | // do we warn users when someone new auths to their account? | |
50 | "warn_clone_auth" "1"; | |
51 | // what is the default maxlogins value? | |
52 | "default_maxlogins" "2"; | |
53 | // what is the absolute maxlogins value? | |
54 | "hard_maxlogins" "10"; | |
55 | // This names a file that contains easily guessed passwords. | |
56 | // It always contains "password", "<password>" and the user's | |
57 | // account name. | |
58 | "dict_file" "/usr/share/dict/words"; | |
59 | // Minimum number of various types of characters permitted in | |
60 | // a password. | |
61 | "password_min_length" "4"; | |
62 | "password_min_digits" "1"; | |
63 | "password_min_upper" "0"; | |
64 | "password_min_lower" "0"; | |
65 | // What should valid account and nicks look like? | |
66 | // If valid_nick_regex is omitted, valid_account_regex is used | |
67 | // for both nicks and accounts. | |
68 | // These look funny because "[][-]" is the only way to write the | |
69 | // character class containing the characters ']', '[' and '-'. | |
70 | "valid_account_regex" "^[][_a-z^`'{}|-][][_a-z0-9^`'{}|-]*$"; | |
71 | "valid_nick_regex" "^[-_a-z][-_a-z0-9]*$"; | |
72 | ||
73 | // Should nick ownership be disabled? | |
74 | "disable_nicks" "0"; | |
75 | // One account may only own this many nicks. | |
76 | "nicks_per_account" "4"; | |
77 | // Send a warning when someone uses a registered nick? | |
78 | "warn_nick_owned" "0"; | |
79 | // What to do when someone uses the NickServ "reclaim" command? | |
80 | // This can be one of "none", "warn", "svsnick", or "kill", but | |
81 | // stock ircu does not support svsnick -- you need Bahamut or a | |
82 | // patch for ircu. no, don't ask srvx developers for the patch. | |
83 | "reclaim_action" "none"; | |
84 | // What (else) to do when someone uses a registered nick? | |
85 | // This can be anything "reclaim_action" can be, but it makes | |
86 | // more sense to use the "warn_nick_owned" instead of "warn". | |
87 | "auto_reclaim_action" "none"; | |
88 | // How long to wait before doing the auto_reclaim_action? | |
89 | // This is ignored if "auto_reclaim_action" is "none". | |
90 | "auto_reclaim_delay" "0"; | |
91 | ||
92 | // access control for who can change account flags | |
93 | "flag_levels" { | |
94 | "g" "800"; | |
95 | "lc_h" "800"; // specifically lower case h | |
96 | "uc_H" "800"; // .. and upper case H | |
97 | "S" "999"; | |
98 | "b" "1"; | |
99 | }; | |
100 | // and for who can change epithets for staff | |
101 | "set_epithet_level" "800"; | |
102 | // what opserv access level do you need to set somebody else's level? | |
103 | "modoper_level" "850"; | |
104 | ||
105 | // how often should accounts be expired? | |
106 | "account_expire_freq" "1d"; | |
107 | // how long until an account with access to any channel(s) expires? | |
108 | "account_expire_delay" "35d"; | |
109 | // how long until an account with no access to any channels expires? | |
110 | "nochan_account_expire_delay" "14d"; | |
111 | /* "require_qualified" has been removed. It is now | |
112 | * integrated into the modcmd command authorization | |
113 | * and dispatch mechanism. "/msg OpServ help modcmd" | |
114 | * for details. | |
115 | */ | |
116 | // If somebody keeps guessing passwords incorrectly, do we gag them? | |
117 | "autogag_enabled" "1"; | |
118 | "autogag_duration" "30m"; | |
119 | "auth_policer" { | |
120 | "size" "5"; | |
121 | "drain-rate" "0.05"; | |
122 | }; | |
123 | // How to integrate with email cookies? | |
124 | "email_enabled" "0"; // if set, /mail/enable MUST be set too | |
125 | "email_required" "0"; // ignored unless email_enabled is non-zero | |
126 | "cookie_timeout" "1d"; // how long before we expire cookies? | |
127 | "accounts_per_email" "1"; // you may want to increase this; or not | |
128 | "email_search_level" "600"; // minimum OpServ level to search based on email address | |
129 | "email_visible_level" "800"; // minimum OpServ level to see somebody's email address | |
130 | }; | |
131 | ||
132 | "opserv" { | |
133 | "nick" "OpServ"; | |
134 | // should use of this service be limited to global opers? | |
135 | "privileged" "1"; | |
136 | // fullname for service | |
137 | "description" "Oper Service Bot"; | |
138 | // hostname for service; only used if "description" is also set | |
139 | "hostname" "dances-all-night-with.srvx.net"; | |
140 | // what channel should opserv send debug output to? | |
141 | "debug_channel" "#opserv"; | |
142 | "debug_channel_modes" "+tinms"; | |
143 | // where to send general alerts (e.g. flood alerts)? | |
144 | "alert_channel" "#ircops"; | |
145 | "alert_channel_modes" "+tns"; | |
146 | // who to tell about staff auths? | |
147 | "staff_auth_channel" "#opserv"; | |
148 | "staff_auth_channel_modes" "+tinms"; | |
149 | // how many clones to allow from an untrusted host? | |
150 | "untrusted_max" "4"; | |
151 | // how long of a g-line should be issued if the max hosts is exceeded? | |
152 | "clone_gline_duration" "1h"; | |
153 | // how long to g-line for ?block (or, by default, for ?trace gline)? | |
154 | "block_gline_duration" "1h"; | |
155 | // how long to keep an illegal channel locked down (seconds)? | |
156 | "purge_lock_delay" "60"; | |
157 | // channel join flood policer params? | |
158 | "join_policer" { | |
159 | "size" "20"; | |
160 | "drain-rate" "1"; | |
161 | }; | |
162 | // automatically moderate join flooded channels? | |
163 | "join_flood_moderate" "1"; | |
164 | // Don't moderate and warn channels unless there are more than | |
165 | // join_flood_moderate_threshold users in the channel. the | |
166 | // value 0 will disable the threshold. | |
167 | "join_flood_moderate_threshold" "50"; | |
168 | // new user flood policer params | |
169 | "new_user_policer" { | |
170 | "size" "200"; | |
171 | "drain-rate" "3"; | |
172 | }; | |
173 | }; | |
174 | ||
175 | "chanserv" { | |
176 | // You may disable a service by removing its "nick" config item. | |
177 | // That means: SERVICES WILL ONLY WORK IF YOU DEFINE THEIR NICK. | |
178 | // (This is changed relative srvx-1.0.x, which would use default | |
179 | // unless you specified ".disabled".) | |
180 | "nick" "ChanServ"; | |
181 | // Does your ircd have off-channel services support? | |
182 | // Bahamut does; ircu2.10.11 does not. | |
183 | "off_channel" "no"; | |
184 | // how long should a person be unseen before resending infoline? | |
185 | "info_delay" "120"; | |
186 | // maximum greeting length | |
187 | "max_greetlen" "120"; | |
188 | // maximum users in a channel userlist | |
189 | "max_chan_users" "512"; | |
190 | // maximum bans on a channel banlist | |
191 | "max_chan_bans" "512"; | |
192 | // maximum length of a user's infoline | |
193 | "max_userinfo_length" "400"; | |
194 | // If DynLimit is on and there are N users in the channel, ChanServ will | |
195 | // try to keep the limit at N+<adjust_threshold>. | |
196 | "adjust_threshold" "15"; | |
197 | // .. but ChanServ will only increment or decrement the limit this often. | |
198 | "adjust_delay" "30"; | |
199 | // How often to look for channels that have expired? | |
200 | "chan_expire_freq" "3d"; | |
201 | // How long is a channel unvisited (by masters or above) before it can be expired? | |
202 | "chan_expire_delay" "30d"; | |
203 | // what !set options should we show when user calls "!set" with no arguments? | |
204 | "set_shows" ("DefaultTopic", "TopicMask", "Greeting", "UserGreeting", "Modes", "PubCmd", "InviteMe", "UserInfo", "GiveVoice", "GiveOps", "EnfOps", "EnfModes", "EnfTopic", "TopicSnarf", "Setters", "CtcpUser", "CtcpReaction", "Protect", "Toys", "DynLimit", "NoDelete"); | |
205 | ||
206 | // A list of !8ball responses | |
207 | "8ball" ("Not a chance.", | |
208 | "In your dreams.", | |
209 | "Absolutely!", | |
210 | "Could be, could be."); | |
211 | // channel(s) that support helpers must be in to be helping | |
212 | // if this is a list, any one by itself will do | |
213 | "support_channel" ("#support", "#registration"); | |
214 | // maximum number of channels owned by one account before FORCE is required | |
215 | "max_owned" "5"; | |
216 | // how long between automatic topic refreshes with TopicRefresh 0 | |
217 | "refresh_period" "3h"; | |
218 | // what should !access say for various staff? | |
219 | "irc_operator_epithet" "a megalomaniacal power hungry tyrant"; | |
220 | "network_helper_epithet" "a wannabe tyrant"; | |
221 | "support_helper_epithet" "a wannabe tyrant"; | |
222 | // what should a newly registered channel get as its modes? | |
223 | "default_modes" "+nt"; | |
224 | // minimum opserv access to set, clear or override nodelete setting? | |
225 | "nodelete_level" "1"; | |
226 | }; | |
227 | ||
228 | "global" { | |
229 | "nick" "Global"; | |
230 | // should users get community announcements by default or not? | |
231 | "announcements_default" "on"; | |
232 | }; | |
233 | }; | |
234 | ||
235 | // The modules section gives configuration information to optional modules. | |
236 | "modules" { | |
237 | "helpserv" { | |
238 | // The description/fullname field | |
239 | "description" "Help Queue Manager"; | |
240 | // HelpServ bots log all of their requests to this file, with | |
241 | // details on when they were opened, closed, their contents, | |
242 | // helper, etc. The file is written in saxdb format for easy | |
243 | // parsing by external programs. Please note that you cannot | |
244 | // use ?set to change this value while srvx is running. | |
245 | "reqlogfile" "helpservreq.log"; | |
246 | // How long should a helpserv be inactive (no requests assigned) | |
247 | // before it can be unregistered by the expire command? | |
248 | "expiration" "60d"; | |
249 | }; | |
250 | "sockcheck" { | |
251 | "max_sockets" "64"; // allow 64 concurrent clients to be checked | |
252 | "max_read" "1024"; // don't read more than 1024 bytes from any client | |
253 | "gline_duration" "1h"; // issue G-lines lasting one hour | |
254 | "max_cache_age" "60"; // only cache results for 60 seconds | |
255 | // "address" "192.168.0.10"; // do proxy tests from this address | |
256 | }; | |
257 | "snoop" { | |
258 | // Where to send snoop messages? | |
259 | "channel" "#wherever"; | |
260 | // Which bot? | |
261 | "bot" "OpServ"; | |
262 | // Show new users and joins from net joins? (off by default) | |
263 | "show_bursts" "0"; | |
264 | }; | |
265 | "memoserv" { | |
266 | "bot" "NickServ"; | |
267 | "message_expiry" "30d"; // age when messages are deleted; set | |
268 | // to 0 to disable message expiration | |
269 | }; | |
270 | }; | |
271 | ||
272 | "policers" { | |
273 | "commands-luser" { | |
274 | "size" "5"; | |
275 | "drain-rate" "0.5"; | |
276 | }; | |
277 | }; | |
278 | ||
279 | "rlimits" { | |
280 | "data" "50M"; | |
281 | "stack" "6M"; | |
282 | "vmem" "100M"; | |
283 | }; | |
284 | ||
285 | "server" { | |
286 | "hostname" "localhost.domain"; | |
287 | "description" "Network Services"; | |
288 | "network" "GenericNET"; | |
289 | "hidden_host" "users.Generic.NET"; // set this if you enabled ircd/Undernet's +x mode | |
290 | /* hidden_host should match the F:HIDDEN_HOST: line in your ircu's ircd.conf; | |
291 | * srvx does not set the host suffix for users, but must know it when making | |
292 | * things like bans, where it should not show the user's real hostname. */ | |
293 | "numeric" "10"; // hint: If you get collisions on link, CHANGE THIS. | |
294 | "max_users" "256"; // You can save a little memory by setting this to a lower value. | |
295 | "force_n2k" "1"; // Use extended (5-digit) numnick for self, even if 3 are possible. | |
296 | "ping_freq" "60"; | |
297 | "ping_timeout" "90"; | |
298 | "max_cycles" "30"; // max uplink cycles before giving up | |
299 | // Admin information is traditionally: location, location, email | |
300 | "admin" ("IRC Network", "Gotham City, GO", "Mr Commissioner <james.gordon@police.gov>"); | |
301 | /* the following two settings are for ircu's HEAD_IN_SAND features, and are equivelent to | |
302 | * the F: lines in ircu's ircd.conf. both can be disabled by commenting them out. */ | |
303 | "his_servername" "*.Generic.NET"; // hidden server name, shown in remote /whois requests | |
304 | "his_servercomment" "The Generic, Boring IRC Network"; | |
305 | }; | |
306 | ||
307 | // controlling how services (mostly NickServ) send mail | |
308 | "mail" { | |
309 | // These options are the defaults. | |
310 | "enable" "0"; | |
311 | "mailer" "/usr/sbin/sendmail"; | |
312 | "from_address" "admin@poorly.configured.server"; | |
313 | // These are not :> | |
314 | "extra_headers" ("X-Ereet-Services: srvx r reet"); | |
315 | "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."); | |
316 | "body_prefix" ("This goes before the mail text.", "Each string here is treated as a separate \"paragraph\" for line wrapping."); | |
317 | "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."); | |
318 | "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!"); | |
319 | }; | |
320 | ||
321 | // New section in srvx-1.2 to control database locations, etc. | |
322 | // If you leave this section out, each database will be in its own file, | |
323 | // and they will be written out every half hour. | |
324 | "dbs" { | |
325 | // This just illustrates how you can jam every database into one huge ("mondo") file. | |
326 | "ChanServ" { "mondo_section" "ChanServ"; }; | |
327 | "gline" { "mondo_section" "gline"; }; | |
328 | "Global" { "mondo_section" "Global"; }; | |
329 | "HelpServ" { "mondo_section" "HelpServ"; }; | |
330 | "modcmd" { "mondo_section" "modcmd"; }; | |
331 | "NickServ" { "mondo_section" "NickServ"; }; | |
332 | "OpServ" { "mondo_section" "OpServ"; }; | |
333 | "sendmail" { "mondo_section" "sendmail"; }; | |
334 | ||
335 | // These are the options if you want a database to be in its own file. | |
336 | "mondo" { | |
337 | // Where to put it? | |
338 | "filename" "srvx.db"; | |
339 | // How often should it be saved? | |
340 | // (You can disable automatic saves by setting this to 0.) | |
341 | "frequency" "30m"; | |
342 | }; | |
343 | }; | |
344 | ||
345 | // New section in srvx-1.2 to control log destinations. | |
346 | // If you leave this section out, each service (technically, each log | |
347 | // facility) will be in its own file, just like before. | |
348 | "logs" { | |
349 | // Two kinds of items exist in this section. | |
350 | ||
351 | // One is a facility configuration subsection. These have the | |
352 | // name of a log facility (one of "ChanServ", "Global", | |
353 | // "HelpServ", "NickServ", "OpServ", "ProxyCheck", or "srvx") and | |
354 | // the value is a subsection. The "srvx" log facility is a | |
355 | // catch-all/fall-back facility. | |
356 | "srvx" { | |
357 | // The "max_age" option says how long to keep log audit entries. | |
358 | "max_age" "10m"; | |
359 | // The "max_count" option says how many log audit entries to keep. | |
360 | "max_count" "1024"; | |
361 | // Audit (command tracking) entries are discarded if they exceed | |
362 | // either limit: for example, if entry 500 is 10 minutes old, it | |
363 | // will be discarded next time any audit command is logged. | |
364 | }; | |
365 | ||
366 | // The other kind of item is a target list. The name of each is a | |
367 | // description of facility-and-severity combinations, and the value | |
368 | // is a string (or list of strings) that describe where matching | |
369 | // events should be logged. As a special case, the facility * will | |
370 | // specify how to log events regardless of their true facility, and | |
371 | // the severity * will match all severities for a facility. | |
372 | // Log targets use a psuedo-URI syntax: one of "file:filename", | |
373 | // "std:[out|err|n]" where n is a valid file descriptor, or | |
374 | // "irc:#channel" (nicknames or server masks can be used instead | |
375 | // of channel names, but should be used with care). | |
376 | // The severity is one of "replay", "debug", "command", "info", | |
377 | // "override", "staff", "warning", "error", or "fatal". | |
378 | // WARNING: If any severity except "replay" for a facility is left | |
379 | // unspecified, it will use the default target (for example, | |
380 | // "file:chanserv.log"). For "replay" severity, you must ALWAYS | |
381 | // list a target to log it -- this is because it is very rarely | |
382 | // useful. | |
383 | "*.*" ("std:out", "file:everything.log"); // does NOT suppress any defaults | |
384 | "*.override,staff" "irc:#big-brother"; // report all uses of staff commands | |
385 | "ChanServ.*" "file:chanserv.log"; // duplicates the default behavior | |
386 | "ProxyCheck.*" (); // stop it from logging anything | |
387 | }; |