]> git.openstreetmap.org Git - chef.git/blob - cookbooks/supybot/templates/default/supybot.conf.erb
Use SSL when connecting to IRC
[chef.git] / cookbooks / supybot / templates / default / supybot.conf.erb
1 # DO NOT EDIT - This file is being maintained by Chef
2
3 ###
4 # Determines the bot's default nick.
5 #
6 # Default value: supybot
7 ###
8 supybot.nick: osmbot
9
10 ###
11 # Determines what alternative nicks will be used if the primary nick
12 # (supybot.nick) isn't available. A %s in this nick is replaced by the
13 # value of supybot.nick when used. If no alternates are given, or if all
14 # are used, the supybot.nick will be perturbed appropriately until an
15 # unused nick is found.
16 #
17 # Default value: %s` %s_
18 ###
19 supybot.nick.alternates: %s` %s_
20
21 ###
22 # Determines the bot's ident string, if the server doesn't provide one
23 # by default.
24 #
25 # Default value: supybot
26 ###
27 supybot.ident: supybot
28
29 ###
30 # Determines the user the bot sends to the server. A standard user using
31 # the current version of the bot will be generated if this is left
32 # empty.
33 #
34 # Default value: 
35 ###
36 supybot.user: 
37
38 ###
39 # Determines what networks the bot will connect to.
40 #
41 # Default value:  
42 ###
43 supybot.networks: oftc
44
45 ###
46 # Determines what password will be used on oftc. Yes, we know that
47 # technically passwords are server-specific and not network-specific,
48 # but this is the best we can do right now.
49 #
50 # Default value: 
51 ###
52 supybot.networks.oftc.password: 
53
54 ###
55 # Determines what servers the bot will connect to for oftc. Each will be
56 # tried in order, wrapping back to the first when the cycle is
57 # completed.
58 #
59 # Default value: 
60 ###
61 supybot.networks.oftc.servers: irc.oftc.net:6697
62
63 ###
64 # Determines what channels the bot will join only on oftc.
65 #
66 # Default value:  
67 ###
68 supybot.networks.oftc.channels: #osm-dev
69
70 ###
71 # Determines what key (if any) will be used to join the channel.
72 #
73 # Default value: 
74 ###
75 supybot.networks.oftc.channels.key: 
76
77 ###
78 # Determines whether the bot will attempt to connect with SSL sockets to
79 # oftc.
80 #
81 # Default value: False
82 ###
83 supybot.networks.oftc.ssl: True
84
85 ###
86 # Determines how timestamps printed for human reading should be
87 # formatted. Refer to the Python documentation for the time module to
88 # see valid formatting characters for time formats.
89 #
90 # Default value: %I:%M %p, %B %d, %Y
91 ###
92 supybot.reply.format.time: %I:%M %p, %B %d, %Y
93
94 ###
95 # Determines whether elapsed times will be given as "1 day, 2 hours, 3
96 # minutes, and 15 seconds" or as "1d 2h 3m 15s".
97 #
98 # Default value: False
99 ###
100 supybot.reply.format.time.elapsed.short: False
101
102 ###
103 # Determines the absolute maximum length of the bot's reply -- no reply
104 # will be passed through the bot with a length greater than this.
105 #
106 # Default value: 131072
107 ###
108 supybot.reply.maximumLength: 131072
109
110 ###
111 # Determines whether the bot will break up long messages into chunks and
112 # allow users to use the 'more' command to get the remaining chunks.
113 #
114 # Default value: True
115 ###
116 supybot.reply.mores: True
117
118 ###
119 # Determines what the maximum number of chunks (for use with the 'more'
120 # command) will be.
121 #
122 # Default value: 50
123 ###
124 supybot.reply.mores.maximum: 50
125
126 ###
127 # Determines how long individual chunks will be. If set to 0, uses our
128 # super-tweaked, get-the-most-out-of-an-individual-message default.
129 #
130 # Default value: 0
131 ###
132 supybot.reply.mores.length: 0
133
134 ###
135 # Determines how many mores will be sent instantly (i.e., without the
136 # use of the more command, immediately when they are formed). Defaults
137 # to 1, which means that a more command will be required for all but the
138 # first chunk.
139 #
140 # Default value: 1
141 ###
142 supybot.reply.mores.instant: 1
143
144 ###
145 # Determines whether the bot will send multi-message replies in a single
146 # message or in multiple messages. For safety purposes (so the bot is
147 # less likely to flood) it will normally send everything in a single
148 # message, using mores if necessary.
149 #
150 # Default value: True
151 ###
152 supybot.reply.oneToOne: True
153
154 ###
155 # Determines whether the bot will reply with an error message when it is
156 # addressed but not given a valid command. If this value is False, the
157 # bot will remain silent, as long as no other plugins override the
158 # normal behavior.
159 #
160 # Default value: True
161 ###
162 supybot.reply.whenNotCommand: True
163
164 ###
165 # Determines whether error messages that result from bugs in the bot
166 # will show a detailed error message (the uncaught exception) or a
167 # generic error message.
168 #
169 # Default value: False
170 ###
171 supybot.reply.error.detailed: False
172
173 ###
174 # Determines whether the bot will send error messages to users in
175 # private. You might want to do this in order to keep channel traffic to
176 # minimum. This can be used in combination with
177 # supybot.reply.error.withNotice.
178 #
179 # Default value: False
180 ###
181 supybot.reply.error.inPrivate: False
182
183 ###
184 # Determines whether the bot will send error messages to users via
185 # NOTICE instead of PRIVMSG. You might want to do this so users can
186 # ignore NOTICEs from the bot and not have to see error messages; or you
187 # might want to use it in combination with supybot.reply.errorInPrivate
188 # so private errors don't open a query window in most IRC clients.
189 #
190 # Default value: False
191 ###
192 supybot.reply.error.withNotice: False
193
194 ###
195 # Determines whether the bot will send an error message to users who
196 # attempt to call a command for which they do not have the necessary
197 # capability. You may wish to make this True if you don't want users to
198 # understand the underlying security system preventing them from running
199 # certain commands.
200 #
201 # Default value: False
202 ###
203 supybot.reply.error.noCapability: False
204
205 ###
206 # Determines whether the bot will reply privately when replying in a
207 # channel, rather than replying to the whole channel.
208 #
209 # Default value: False
210 ###
211 supybot.reply.inPrivate: False
212
213 ###
214 # Determines whether the bot will reply with a notice when replying in a
215 # channel, rather than replying with a privmsg as normal.
216 #
217 # Default value: False
218 ###
219 supybot.reply.withNotice: False
220
221 ###
222 # Determines whether the bot will reply with a notice when it is sending
223 # a private message, in order not to open a /query window in clients.
224 # This can be overridden by individual users via the user configuration
225 # variable reply.withNoticeWhenPrivate.
226 #
227 # Default value: False
228 ###
229 supybot.reply.withNoticeWhenPrivate: False
230
231 ###
232 # Determines whether the bot will always prefix the user's nick to its
233 # reply to that user's command.
234 #
235 # Default value: True
236 ###
237 supybot.reply.withNickPrefix: True
238
239 ###
240 # Determines whether the bot should attempt to reply to all messages
241 # even if they don't address it (either via its nick or a prefix
242 # character). If you set this to True, you almost certainly want to set
243 # supybot.reply.whenNotCommand to False.
244 #
245 # Default value: False
246 ###
247 supybot.reply.whenNotAddressed: False
248
249 ###
250 # Determines whether the bot will allow you to send channel-related
251 # commands outside of that channel. Sometimes people find it confusing
252 # if a channel-related command (like Filter.outfilter) changes the
253 # behavior of the channel but was sent outside the channel itself.
254 #
255 # Default value: False
256 ###
257 supybot.reply.requireChannelCommandsToBeSentInChannel: False
258
259 ###
260 # Supybot normally replies with the full help whenever a user misuses a
261 # command. If this value is set to True, the bot will only reply with
262 # the syntax of the command (the first line of the help) rather than the
263 # full help.
264 #
265 # Default value: False
266 ###
267 supybot.reply.showSimpleSyntax: False
268
269 ###
270 # Determines what prefix characters the bot will reply to. A prefix
271 # character is a single character that the bot will use to determine
272 # what messages are addressed to it; when there are no prefix characters
273 # set, it just uses its nick. Each character in this string is
274 # interpreted individually; you can have multiple prefix chars
275 # simultaneously, and if any one of them is used as a prefix the bot
276 # will assume it is being addressed.
277 #
278 # Default value: 
279 ###
280 supybot.reply.whenAddressedBy.chars: !
281
282 ###
283 # Determines what strings the bot will reply to when they are at the
284 # beginning of the message. Whereas prefix.chars can only be one
285 # character (although there can be many of them), this variable is a
286 # space-separated list of strings, so you can set something like '@@ ??'
287 # and the bot will reply when a message is prefixed by either @@ or ??.
288 #
289 # Default value:  
290 ###
291 supybot.reply.whenAddressedBy.strings:  
292
293 ###
294 # Determines whether the bot will reply when people address it by its
295 # nick, rather than with a prefix character.
296 #
297 # Default value: True
298 ###
299 supybot.reply.whenAddressedBy.nick: True
300
301 ###
302 # Determines whether the bot will reply when people address it by its
303 # nick at the end of the message, rather than at the beginning.
304 #
305 # Default value: False
306 ###
307 supybot.reply.whenAddressedBy.nick.atEnd: False
308
309 ###
310 # Determines what extra nicks the bot will always respond to when
311 # addressed by, even if its current nick is something else.
312 #
313 # Default value:  
314 ###
315 supybot.reply.whenAddressedBy.nicks:  
316
317 ###
318 # Determines whether the bot will unidentify someone when that person
319 # changes his or her nick. Setting this to True will cause the bot to
320 # track such changes. It defaults to False for a little greater
321 # security.
322 #
323 # Default value: False
324 ###
325 supybot.followIdentificationThroughNickChanges: False
326
327 ###
328 # Determines whether the bot will always join a channel when it's
329 # invited. If this value is False, the bot will only join a channel if
330 # the user inviting it has the 'admin' capability (or if it's explicitly
331 # told to join the channel using the Admin.join command)
332 #
333 # Default value: False
334 ###
335 supybot.alwaysJoinOnInvite: False
336
337 ###
338 # Determines what message the bot replies with when a command succeeded.
339 # If this configuration variable is empty, no success message will be
340 # sent.
341 ###
342 supybot.replies.success: The operation succeeded.
343
344 ###
345 # Determines what error message the bot gives when it wants to be
346 # ambiguous.
347 ###
348 supybot.replies.error: An error has occurred and has been logged. Please\
349                        contact this bot's administrator for more\
350                        information.
351
352 ###
353 # Determines what message the bot replies with when someone tries to use
354 # a command that requires being identified or having a password and
355 # neither credential is correct.
356 ###
357 supybot.replies.incorrectAuthentication: Your hostmask doesn't match or your\
358                                          password is wrong.
359
360 ###
361 # Determines what error message the bot replies with when someone tries
362 # to accessing some information on a user the bot doesn't know about.
363 ###
364 supybot.replies.noUser: I can't find %s in my user database. If you didn't\
365                         give a user name, then I might not know what your\
366                         user is, and you'll need to identify before this\
367                         command might work.
368
369 ###
370 # Determines what error message the bot replies with when someone tries
371 # to do something that requires them to be registered but they're not
372 # currently recognized.
373 ###
374 supybot.replies.notRegistered: You must be registered to use this command.\
375                                If you are already registered, you must\
376                                either identify (using the identify command)\
377                                or add a hostmask matching your current\
378                                hostmask (using the "hostmask add" command).
379
380 ###
381 # Determines what error message is given when the bot is telling someone
382 # they aren't cool enough to use the command they tried to use.
383 ###
384 supybot.replies.noCapability: You don't have the %s capability. If you think\
385                               that you should have this capability, be sure\
386                               that you are identified before trying again.\
387                               The 'whoami' command can tell you if you're\
388                               identified.
389
390 ###
391 # Determines what generic error message is given when the bot is telling
392 # someone that they aren't cool enough to use the command they tried to
393 # use, and the author of the code calling errorNoCapability didn't
394 # provide an explicit capability for whatever reason.
395 ###
396 supybot.replies.genericNoCapability: You're missing some capability you\
397                                      need. This could be because you\
398                                      actually possess the anti-capability\
399                                      for the capability that's required of\
400                                      you, or because the channel provides\
401                                      that anti-capability by default, or\
402                                      because the global capabilities include\
403                                      that anti-capability. Or, it could be\
404                                      because the channel or\
405                                      supybot.capabilities.default is set to\
406                                      False, meaning that no commands are\
407                                      allowed unless explicitly in your\
408                                      capabilities. Either way, you can't do\
409                                      what you want to do.
410
411 ###
412 # Determines what error messages the bot sends to people who try to do
413 # things in a channel that really should be done in private.
414 ###
415 supybot.replies.requiresPrivacy: That operation cannot be done in a channel.
416
417 ###
418 # Determines what message the bot sends when it thinks you've
419 # encountered a bug that the developers don't know about.
420 ###
421 supybot.replies.possibleBug: This may be a bug. If you think it is, please\
422                              file a bug report at <http://sourceforge.net/tr\
423                              acker/?func=add&group_id=58965&atid=489447>.
424
425 ###
426 # A floating point number of seconds to throttle snarfed URLs, in order
427 # to prevent loops between two bots snarfing the same URLs and having
428 # the snarfed URL in the output of the snarf message.
429 #
430 # Default value: 10.0
431 ###
432 supybot.snarfThrottle: 10.0
433
434 ###
435 # Determines the number of seconds between running the upkeep function
436 # that flushes (commits) open databases, collects garbage, and records
437 # some useful statistics at the debugging level.
438 #
439 # Default value: 3600
440 ###
441 supybot.upkeepInterval: 3600
442
443 ###
444 # Determines whether the bot will periodically flush data and
445 # configuration files to disk. Generally, the only time you'll want to
446 # set this to False is when you want to modify those configuration files
447 # by hand and don't want the bot to flush its current version over your
448 # modifications. Do note that if you change this to False inside the
449 # bot, your changes won't be flushed. To make this change permanent, you
450 # must edit the registry yourself.
451 #
452 # Default value: True
453 ###
454 supybot.flush: False
455
456 ###
457 # Determines what characters are valid for quoting arguments to commands
458 # in order to prevent them from being tokenized.
459 #
460 # Default value: "
461 ###
462 supybot.commands.quotes: "
463
464 ###
465 # Determines whether the bot will allow nested commands, which rule. You
466 # definitely should keep this on.
467 #
468 # Default value: True
469 ###
470 supybot.commands.nested: True
471
472 ###
473 # Determines what the maximum number of nested commands will be; users
474 # will receive an error if they attempt commands more nested than this.
475 #
476 # Default value: 10
477 ###
478 supybot.commands.nested.maximum: 10
479
480 ###
481 # Supybot allows you to specify what brackets are used for your nested
482 # commands. Valid sets of brackets include [], <>, and {} (). [] has
483 # strong historical motivation, as well as being the brackets that don't
484 # require shift. <> or () might be slightly superior because they cannot
485 # occur in a nick. If this string is empty, nested commands will not be
486 # allowed in this channel.
487 #
488 # Default value: []
489 ###
490 supybot.commands.nested.brackets: []
491
492 ###
493 # Supybot allows nested commands. Enabling this option will allow nested
494 # commands with a syntax similar to UNIX pipes, for example: 'bot: foo |
495 # bar'.
496 #
497 # Default value: False
498 ###
499 supybot.commands.nested.pipeSyntax: False
500
501 ###
502 # Determines what commands have default plugins set, and which plugins
503 # are set to be the default for each of those commands.
504 ###
505 supybot.commands.defaultPlugins.addcapability: Admin
506 supybot.commands.defaultPlugins.capabilities: User
507 supybot.commands.defaultPlugins.disable: Owner
508 supybot.commands.defaultPlugins.enable: Owner
509 supybot.commands.defaultPlugins.help: Misc
510 supybot.commands.defaultPlugins.ignore: Admin
511
512 ###
513 # Determines what plugins automatically get precedence over all other
514 # plugins when selecting a default plugin for a command. By default,
515 # this includes the standard loaded plugins. You probably shouldn't
516 # change this if you don't know what you're doing; if you do know what
517 # you're doing, then also know that this set is case-sensitive.
518 #
519 # Default value: Plugin Admin Misc User Owner Config Channel
520 ###
521 supybot.commands.defaultPlugins.importantPlugins: Plugin Admin Misc User Owner Config Channel
522 supybot.commands.defaultPlugins.list: Misc
523 supybot.commands.defaultPlugins.reload: Owner
524 supybot.commands.defaultPlugins.removecapability: Admin
525 supybot.commands.defaultPlugins.unignore: Admin
526
527 ###
528 # Determines what commands are currently disabled. Such commands will
529 # not appear in command lists, etc. They will appear not even to exist.
530 #
531 # Default value:  
532 ###
533 supybot.commands.disabled:  
534
535 ###
536 # Determines whether the bot will defend itself against command-
537 # flooding.
538 #
539 # Default value: True
540 ###
541 supybot.abuse.flood.command: True
542
543 ###
544 # Determines how many commands users are allowed per minute. If a user
545 # sends more than this many commands in any 60 second period, he or she
546 # will be ignored for supybot.abuse.flood.command.punishment seconds.
547 #
548 # Default value: 12
549 ###
550 supybot.abuse.flood.command.maximum: 12
551
552 ###
553 # Determines how many seconds the bot will ignore users who flood it
554 # with commands.
555 #
556 # Default value: 300
557 ###
558 supybot.abuse.flood.command.punishment: 300
559
560 ###
561 # Determines whether the bot will defend itself against invalid command-
562 # flooding.
563 #
564 # Default value: True
565 ###
566 supybot.abuse.flood.command.invalid: True
567
568 ###
569 # Determines how many invalid commands users are allowed per minute. If
570 # a user sends more than this many invalid commands in any 60 second
571 # period, he or she will be ignored for
572 # supybot.abuse.flood.command.invalid.punishment seconds. Typically,
573 # this value is lower than supybot.abuse.flood.command.maximum, since
574 # it's far less likely (and far more annoying) for users to flood with
575 # invalid commands than for them to flood with valid commands.
576 #
577 # Default value: 5
578 ###
579 supybot.abuse.flood.command.invalid.maximum: 5
580
581 ###
582 # Determines how many seconds the bot will ignore users who flood it
583 # with invalid commands. Typically, this value is higher than
584 # supybot.abuse.flood.command.punishment, since it's far less likely
585 # (and far more annoying) for users to flood witih invalid commands than
586 # for them to flood with valid commands.
587 #
588 # Default value: 600
589 ###
590 supybot.abuse.flood.command.invalid.punishment: 600
591
592 ###
593 # Determines the default length of time a driver should block waiting
594 # for input.
595 #
596 # Default value: 1.0
597 ###
598 supybot.drivers.poll: 1.0
599
600 ###
601 # Determines what driver module the bot will use. Socket, a simple
602 # driver based on timeout sockets, is used by default because it's
603 # simple and stable. Twisted is very stable and simple, and if you've
604 # got Twisted installed, is probably your best bet.
605 #
606 # Default value: default
607 ###
608 supybot.drivers.module: default
609
610 ###
611 # Determines the maximum time the bot will wait before attempting to
612 # reconnect to an IRC server. The bot may, of course, reconnect earlier
613 # if possible.
614 #
615 # Default value: 300.0
616 ###
617 supybot.drivers.maxReconnectWait: 300.0
618
619 ###
620 # Determines what directory configuration data is put into.
621 #
622 # Default value: conf
623 ###
624 supybot.directories.conf: /etc/supybot
625
626 ###
627 # Determines what directory data is put into.
628 #
629 # Default value: data
630 ###
631 supybot.directories.data: /var/lib/supybot/data
632
633 ###
634 # Determines what directory temporary files are put into.
635 #
636 # Default value: tmp
637 ###
638 supybot.directories.data.tmp: /var/lib/supybot/data/tmp
639
640 ###
641 # Determines what directory files of the web server (templates, custom images, ...) are put into.
642 #
643 # Default value: web
644 ###
645 supybot.directories.data.web: /var/lib/supybot/data/web
646
647 ###
648 # Determines what directory backup data is put into.
649 #
650 # Default value: backup
651 ###
652 supybot.directories.backup: /var/lib/supybot/backup
653
654 ###
655 # Determines what directories the bot will look for plugins in. Accepts
656 # a comma-separated list of strings. This means that to add another
657 # directory, you can nest the former value and add a new one. E.g. you
658 # can say: bot: 'config supybot.directories.plugins [config
659 # supybot.directories.plugins], newPluginDirectory'.
660 #
661 # Default value:  
662 ###
663 supybot.directories.plugins: /usr/local/lib/supybot/plugins
664
665 ###
666 # Determines what directory the bot will store its logfiles in.
667 #
668 # Default value: logs
669 ###
670 supybot.directories.log: /var/log/supybot
671
672 ###
673 # Determines what plugins will be loaded.
674 #
675 # Default value:  
676 ###
677 supybot.plugins: Git Admin Misc Owner User Services Config Channel
678
679 ###
680 # Determines whether this plugin is loaded by default.
681 ###
682 supybot.plugins.Admin: True
683
684 ###
685 # Determines whether this plugin is publicly visible.
686 #
687 # Default value: True
688 ###
689 supybot.plugins.Admin.public: True
690
691 ###
692 # Determines whether this plugin is loaded by default.
693 ###
694 supybot.plugins.Channel: True
695
696 ###
697 # Determines whether this plugin is publicly visible.
698 #
699 # Default value: True
700 ###
701 supybot.plugins.Channel.public: True
702
703 ###
704 # Determines whether the bot will always try to rejoin a channel
705 # whenever it's kicked from the channel.
706 #
707 # Default value: True
708 ###
709 supybot.plugins.Channel.alwaysRejoin: True
710
711 ###
712 # Determines whether this plugin is loaded by default.
713 ###
714 supybot.plugins.Config: True
715
716 ###
717 # Determines whether this plugin is publicly visible.
718 #
719 # Default value: True
720 ###
721 supybot.plugins.Config.public: True
722
723 ###
724 # Determines whether this plugin is loaded by default.
725 ###
726 supybot.plugins.Git: True
727
728 ###
729 # Determines whether this plugin is publicly visible.
730 #
731 # Default value: True
732 ###
733 supybot.plugins.Git.public: True
734
735 ###
736 # The path to the repository configuration file.
737 #
738 # Default value: git.ini
739 ###
740 supybot.plugins.Git.configFile: /etc/supybot/git.conf
741
742 ###
743 # The path where local copies of repositories will be kept.
744 #
745 # Default value: git_repositories
746 ###
747 supybot.plugins.Git.repoDir: /var/lib/supybot/git
748
749 ###
750 # The frequency (in seconds) repositories will be polled for changes.
751 # Set to zero to disable polling.
752 #
753 # Default value: 120
754 ###
755 supybot.plugins.Git.pollPeriod: 120
756
757 ###
758 # How many commits are displayed at once from each repository.
759 #
760 # Default value: 5
761 ###
762 supybot.plugins.Git.maxCommitsAtOnce: 10
763
764 ###
765 # Look for SHAs in user messages written to the channel, and reply with
766 # the commit description if one is found.
767 #
768 # Default value: True
769 ###
770 supybot.plugins.Git.shaSnarfing: True
771
772 ###
773 # Determines whether this plugin is loaded by default.
774 ###
775 supybot.plugins.Misc: True
776
777 ###
778 # Determines whether this plugin is publicly visible.
779 #
780 # Default value: True
781 ###
782 supybot.plugins.Misc.public: True
783
784 ###
785 # Determines whether the bot will list private plugins with the list
786 # command if given the --private switch. If this is disabled, non-owner
787 # users should be unable to see what private plugins are loaded.
788 #
789 # Default value: True
790 ###
791 supybot.plugins.Misc.listPrivatePlugins: True
792
793 ###
794 # Determines the format string for timestamps in the Misc.last command.
795 # Refer to the Python documentation for the time module to see what
796 # formats are accepted. If you set this variable to the empty string,
797 # the timestamp will not be shown.
798 #
799 # Default value: [%H:%M:%S]
800 ###
801 supybot.plugins.Misc.timestampFormat: [%H:%M:%S]
802
803 ###
804 # Determines whether or not the timestamp will be included in the output
805 # of last when it is part of a nested command
806 #
807 # Default value: False
808 ###
809 supybot.plugins.Misc.last.nested.includeTimestamp: False
810
811 ###
812 # Determines whether or not the nick will be included in the output of
813 # last when it is part of a nested command
814 #
815 # Default value: False
816 ###
817 supybot.plugins.Misc.last.nested.includeNick: False
818
819 ###
820 # Determines whether this plugin is loaded by default.
821 ###
822 supybot.plugins.Owner: True
823
824 ###
825 # Determines whether this plugin is publicly visible.
826 #
827 # Default value: True
828 ###
829 supybot.plugins.Owner.public: True
830
831 ###
832 # Determines what quit message will be used by default. If the quit
833 # command is called without a quit message, this will be used. If this
834 # value is empty, the nick of the person giving the quit command will be
835 # used.
836 #
837 # Default value: 
838 ###
839 supybot.plugins.Owner.quitMsg: 
840
841 ###
842 # Determines whether this plugin is loaded by default.
843 ###
844 supybot.plugins.Services: True
845
846 ###
847 # Determines whether this plugin is publicly visible.
848 #
849 # Default value: True
850 ###
851 supybot.plugins.Services.public: True
852
853 ###
854 # Determines what nicks the bot will use with services.
855 #
856 # Default value:  
857 ###
858 supybot.plugins.Services.nicks: osmbot
859
860 ###
861 # Determines what networks this plugin will be disabled on.
862 #
863 # Default value: QuakeNet
864 ###
865 supybot.plugins.Services.disabledNetworks: QuakeNet
866
867 ###
868 # Determines whether the bot will not join any channels until it is
869 # identified. This may be useful, for instances, if you have a vhost
870 # that isn't set until you're identified, or if you're joining +r
871 # channels that won't allow you to join unless you identify.
872 #
873 # Default value: False
874 ###
875 supybot.plugins.Services.noJoinsUntilIdentified: False
876
877 ###
878 # Determines how many seconds the bot will wait between successive GHOST
879 # attempts.
880 #
881 # Default value: 60
882 ###
883 supybot.plugins.Services.ghostDelay: 60
884
885 ###
886 # Determines what nick the 'NickServ' service has.
887 #
888 # Default value: 
889 ###
890 supybot.plugins.Services.NickServ: NickServ
891
892 ###
893 # Determines what password the bot will use with NickServ.
894 #
895 # Default value: 
896 ###
897 supybot.plugins.Services.NickServ.password.osmbot: <%= @passwords["nickserv"] %>
898
899 ###
900 # Determines what nick the 'ChanServ' service has.
901 #
902 # Default value: 
903 ###
904 supybot.plugins.Services.ChanServ: 
905
906 ###
907 # Determines what password the bot will use with ChanServ.
908 #
909 # Default value: 
910 ###
911 supybot.plugins.Services.ChanServ.password: 
912
913 ###
914 # Determines whether the bot will request to get opped by the ChanServ
915 # when it joins the channel.
916 #
917 # Default value: False
918 ###
919 supybot.plugins.Services.ChanServ.op: False
920
921 ###
922 # Determines whether the bot will request to get half-opped by the
923 # ChanServ when it joins the channel.
924 #
925 # Default value: False
926 ###
927 supybot.plugins.Services.ChanServ.halfop: False
928
929 ###
930 # Determines whether the bot will request to get voiced by the ChanServ
931 # when it joins the channel.
932 #
933 # Default value: False
934 ###
935 supybot.plugins.Services.ChanServ.voice: False
936
937 ###
938 # Determines whether this plugin is loaded by default.
939 ###
940 supybot.plugins.User: True
941
942 ###
943 # Determines whether this plugin is publicly visible.
944 #
945 # Default value: True
946 ###
947 supybot.plugins.User.public: True
948
949 ###
950 # Determines whether the bot will always load important plugins (Admin,
951 # Channel, Config, Misc, Owner, and User) regardless of what their
952 # configured state is. Generally, if these plugins are configured not to
953 # load, you didn't do it on purpose, and you still want them to load.
954 # Users who don't want to load these plugins are smart enough to change
955 # the value of this variable appropriately :)
956 #
957 # Default value: True
958 ###
959 supybot.plugins.alwaysLoadImportant: True
960
961 ###
962 # Determines what databases are available for use. If this value is not
963 # configured (that is, if its value is empty) then sane defaults will be
964 # provided.
965 #
966 # Default value: anydbm cdb flat pickle
967 ###
968 supybot.databases: 
969
970 ###
971 # Determines what filename will be used for the users database. This
972 # file will go into the directory specified by the
973 # supybot.directories.conf variable.
974 #
975 # Default value: users.conf
976 ###
977 supybot.databases.users.filename: users.conf
978
979 ###
980 # Determines how long it takes identification to time out. If the value
981 # is less than or equal to zero, identification never times out.
982 #
983 # Default value: 0
984 ###
985 supybot.databases.users.timeoutIdentification: 0
986
987 ###
988 # Determines whether the bot will allow users to unregister their users.
989 # This can wreak havoc with already-existing databases, so by default we
990 # don't allow it. Enable this at your own risk. (Do also note that this
991 # does not prevent the owner of the bot from using the unregister
992 # command.)
993 #
994 # Default value: False
995 ###
996 supybot.databases.users.allowUnregistration: False
997
998 ###
999 # Determines what filename will be used for the ignores database. This
1000 # file will go into the directory specified by the
1001 # supybot.directories.conf variable.
1002 #
1003 # Default value: ignores.conf
1004 ###
1005 supybot.databases.ignores.filename: ignores.conf
1006
1007 ###
1008 # Determines what filename will be used for the channels database. This
1009 # file will go into the directory specified by the
1010 # supybot.directories.conf variable.
1011 #
1012 # Default value: channels.conf
1013 ###
1014 supybot.databases.channels.filename: channels.conf
1015
1016 ###
1017 # Determines whether database-based plugins that can be channel-specific
1018 # will be so. This can be overridden by individual channels. Do note
1019 # that the bot needs to be restarted immediately after changing this
1020 # variable or your db plugins may not work for your channel; also note
1021 # that you may wish to set
1022 # supybot.databases.plugins.channelSpecific.link appropriately if you
1023 # wish to share a certain channel's databases globally.
1024 #
1025 # Default value: True
1026 ###
1027 supybot.databases.plugins.channelSpecific: True
1028
1029 ###
1030 # Determines what channel global (non-channel-specific) databases will
1031 # be considered a part of. This is helpful if you've been running
1032 # channel-specific for awhile and want to turn the databases for your
1033 # primary channel into global databases. If
1034 # supybot.databases.plugins.channelSpecific.link.allow prevents linking,
1035 # the current channel will be used. Do note that the bot needs to be
1036 # restarted immediately after changing this variable or your db plugins
1037 # may not work for your channel.
1038 #
1039 # Default value: #
1040 ###
1041 supybot.databases.plugins.channelSpecific.link: #
1042
1043 ###
1044 # Determines whether another channel's global (non-channel-specific)
1045 # databases will be allowed to link to this channel's databases. Do note
1046 # that the bot needs to be restarted immediately after changing this
1047 # variable or your db plugins may not work for your channel.
1048 #
1049 # Default value: True
1050 ###
1051 supybot.databases.plugins.channelSpecific.link.allow: True
1052
1053 ###
1054 # Determines whether CDB databases will be allowed as a database
1055 # implementation.
1056 #
1057 # Default value: True
1058 ###
1059 supybot.databases.types.cdb: True
1060
1061 ###
1062 # Determines how often CDB databases will have their modifications
1063 # flushed to disk. When the number of modified records is greater than
1064 # this part of the number of unmodified records, the database will be
1065 # entirely flushed to disk.
1066 #
1067 # Default value: 0.5
1068 ###
1069 supybot.databases.types.cdb.maximumModifications: 0.5
1070
1071 ###
1072 # Determines whether server certificates will be verified, which
1073 # checks whether the server certificate is signed by a known certificate
1074 # authority, and aborts the connection if it is not.
1075 #
1076 # Default value: False
1077 ###
1078 supybot.protocols.ssl.verifyCertificates: True
1079
1080 ###
1081 # Determines what will be used as the default banmask style.
1082 #
1083 # Default value: host user
1084 ###
1085 supybot.protocols.irc.banmask: host user
1086
1087 ###
1088 # Determines whether the bot will strictly follow the RFC; currently
1089 # this only affects what strings are considered to be nicks. If you're
1090 # using a server or a network that requires you to message a nick such
1091 # as services@this.network.server then you you should set this to False.
1092 #
1093 # Default value: False
1094 ###
1095 supybot.protocols.irc.strictRfc: False
1096
1097 ###
1098 # Determines what user modes the bot will request from the server when
1099 # it first connects. Many people might choose +i; some networks allow
1100 # +x, which indicates to the auth services on those networks that you
1101 # should be given a fake host.
1102 #
1103 # Default value: 
1104 ###
1105 supybot.protocols.irc.umodes: 
1106
1107 ###
1108 # Determines what vhost the bot will bind to before connecting to the
1109 # IRC server.
1110 #
1111 # Default value: 
1112 ###
1113 supybot.protocols.irc.vhost: 
1114
1115 ###
1116 # Determines how many old messages the bot will keep around in its
1117 # history. Changing this variable will not take effect until the bot is
1118 # restarted.
1119 #
1120 # Default value: 1000
1121 ###
1122 supybot.protocols.irc.maxHistoryLength: 1000
1123
1124 ###
1125 # A floating point number of seconds to throttle queued messages -- that
1126 # is, messages will not be sent faster than once per throttleTime
1127 # seconds.
1128 #
1129 # Default value: 1.0
1130 ###
1131 supybot.protocols.irc.throttleTime: 1.0
1132
1133 ###
1134 # Determines whether the bot will send PINGs to the server it's
1135 # connected to in order to keep the connection alive and discover
1136 # earlier when it breaks. Really, this option only exists for debugging
1137 # purposes: you always should make it True unless you're testing some
1138 # strange server issues.
1139 #
1140 # Default value: True
1141 ###
1142 supybot.protocols.irc.ping: True
1143
1144 ###
1145 # Determines the number of seconds between sending pings to the server,
1146 # if pings are being sent to the server.
1147 #
1148 # Default value: 120
1149 ###
1150 supybot.protocols.irc.ping.interval: 120
1151
1152 ###
1153 # Determines whether the bot will refuse duplicate messages to be queued
1154 # for delivery to the server. This is a safety mechanism put in place to
1155 # prevent plugins from sending the same message multiple times; most of
1156 # the time it doesn't matter, unless you're doing certain kinds of
1157 # plugin hacking.
1158 #
1159 # Default value: False
1160 ###
1161 supybot.protocols.irc.queuing.duplicates: False
1162
1163 ###
1164 # Determines how many seconds must elapse between JOINs sent to the
1165 # server.
1166 #
1167 # Default value: 0.0
1168 ###
1169 supybot.protocols.irc.queuing.rateLimit.join: 0.0
1170
1171 ###
1172 # Determines how many bytes the bot will 'peek' at when looking through
1173 # a URL for a doctype or title or something similar. It'll give up after
1174 # it reads this many bytes, even if it hasn't found what it was looking
1175 # for.
1176 #
1177 # Default value: 4096
1178 ###
1179 supybot.protocols.http.peekSize: 4096
1180
1181 ###
1182 # Determines what proxy all HTTP requests should go through. The value
1183 # should be of the form 'host:port'.
1184 #
1185 # Default value: 
1186 ###
1187 supybot.protocols.http.proxy: 
1188
1189 ###
1190 # Determines whether the bot will ignore unregistered users by default.
1191 # Of course, that'll make it particularly hard for those users to
1192 # register or identify with the bot, but that's your problem to solve.
1193 #
1194 # Default value: False
1195 ###
1196 supybot.defaultIgnore: False
1197
1198 ###
1199 # A string that is the external IP of the bot. If this is the empty
1200 # string, the bot will attempt to find out its IP dynamically (though
1201 # sometimes that doesn't work, hence this variable).
1202 #
1203 # Default value: 
1204 ###
1205 supybot.externalIP: 
1206
1207 ###
1208 # Determines what the default timeout for socket objects will be. This
1209 # means that *all* sockets will timeout when this many seconds has gone
1210 # by (unless otherwise modified by the author of the code that uses the
1211 # sockets).
1212 #
1213 # Default value: 10
1214 ###
1215 supybot.defaultSocketTimeout: 10
1216
1217 ###
1218 # Determines what file the bot should write its PID (Process ID) to, so
1219 # you can kill it more easily. If it's left unset (as is the default)
1220 # then no PID file will be written. A restart is required for changes to
1221 # this variable to take effect.
1222 #
1223 # Default value: 
1224 ###
1225 supybot.pidFile: 
1226
1227 ###
1228 # Determines whether the bot will automatically thread all commands.
1229 #
1230 # Default value: False
1231 ###
1232 supybot.debug.threadAllCommands: False
1233
1234 ###
1235 # Determines whether the bot will automatically flush all flushers
1236 # *very* often. Useful for debugging when you don't know what's breaking
1237 # or when, but think that it might be logged.
1238 #
1239 # Default value: False
1240 ###
1241 supybot.debug.flushVeryOften: False
1242
1243 ###
1244 # Determines what the bot's logging format will be. The relevant
1245 # documentation on the available formattings is Python's documentation
1246 # on its logging module.
1247 #
1248 # Default value: %(levelname)s %(asctime)s %(name)s %(message)s
1249 ###
1250 supybot.log.format: %(levelname)s %(asctime)s %(name)s %(message)s
1251
1252 ###
1253 # Determines what the minimum priority level logged to file will be. Do
1254 # note that this value does not affect the level logged to stdout; for
1255 # that, you should set the value of supybot.log.stdout.level. Valid
1256 # values are DEBUG, INFO, WARNING, ERROR, and CRITICAL, in order of
1257 # increasing priority.
1258 #
1259 # Default value: INFO
1260 ###
1261 supybot.log.level: INFO
1262
1263 ###
1264 # Determines the format string for timestamps in logfiles. Refer to the
1265 # Python documentation for the time module to see what formats are
1266 # accepted. If you set this variable to the empty string, times will be
1267 # logged in a simple seconds-since-epoch format.
1268 #
1269 # Default value: %Y-%m-%dT%H:%M:%S
1270 ###
1271 supybot.log.timestampFormat: %Y-%m-%dT%H:%M:%S
1272
1273 ###
1274 # Determines whether the bot will log to stdout.
1275 #
1276 # Default value: True
1277 ###
1278 supybot.log.stdout: True
1279
1280 ###
1281 # Determines whether the bot's logs to stdout (if enabled) will be
1282 # colorized with ANSI color.
1283 #
1284 # Default value: False
1285 ###
1286 supybot.log.stdout.colorized: False
1287
1288 ###
1289 # Determines whether the bot will wrap its logs when they're output to
1290 # stdout.
1291 #
1292 # Default value: True
1293 ###
1294 supybot.log.stdout.wrap: True
1295
1296 ###
1297 # Determines what the bot's logging format will be. The relevant
1298 # documentation on the available formattings is Python's documentation
1299 # on its logging module.
1300 #
1301 # Default value: %(levelname)s %(asctime)s %(message)s
1302 ###
1303 supybot.log.stdout.format: %(levelname)s %(asctime)s %(message)s
1304
1305 ###
1306 # Determines what the minimum priority level logged will be. Valid
1307 # values are DEBUG, INFO, WARNING, ERROR, and CRITICAL, in order of
1308 # increasing priority.
1309 #
1310 # Default value: INFO
1311 ###
1312 supybot.log.stdout.level: INFO
1313
1314 ###
1315 # Determines whether the bot will separate plugin logs into their own
1316 # individual logfiles.
1317 #
1318 # Default value: False
1319 ###
1320 supybot.log.plugins.individualLogfiles: False
1321
1322 ###
1323 # Determines what the bot's logging format will be. The relevant
1324 # documentation on the available formattings is Python's documentation
1325 # on its logging module.
1326 #
1327 # Default value: %(levelname)s %(asctime)s %(message)s
1328 ###
1329 supybot.log.plugins.format: %(levelname)s %(asctime)s %(message)s
1330
1331 ###
1332 # These are the capabilities that are given to everyone by default. If
1333 # they are normal capabilities, then the user will have to have the
1334 # appropriate anti-capability if you want to override these
1335 # capabilities; if they are anti-capabilities, then the user will have
1336 # to have the actual capability to override these capabilities. See
1337 # docs/CAPABILITIES if you don't understand why these default to what
1338 # they do.
1339 #
1340 # Default value: -owner -admin -trusted
1341 ###
1342 supybot.capabilities: -owner -admin -trusted
1343
1344 ###
1345 # Determines whether the bot by default will allow users to have a
1346 # capability. If this is disabled, a user must explicitly have the
1347 # capability for whatever command he wishes to run.
1348 #
1349 # Default value: True
1350 ###
1351 supybot.capabilities.default: True