]> git.donarmstrong.com Git - infobot.git/blobdiff - files/sample/infobot.config
* Merge changes from prposed changes
[infobot.git] / files / sample / infobot.config
diff --git a/files/sample/infobot.config b/files/sample/infobot.config
new file mode 100644 (file)
index 0000000..073a81e
--- /dev/null
@@ -0,0 +1,229 @@
+# infobot configuration file, modify it to your own taste.  infobot reads
+# this file from files/infobot.config so it should be moved there.
+
+#####
+# Basic IRC info
+#####
+set ircNick            infobot
+set ircUser            infobot
+set ircName            infobot experimental bot
+# if your irc network requires a password to get on the servers
+#set ircPasswd         SomePassword
+set ircUMode           +iw
+
+# if not using a virtualhost set to 0.0.0.0
+# otherwise IRC::Connection might try localhost which will NOT work
+###set ircHost         vh.virtualhost.org
+set ircHost            0.0.0.0
+
+set owner              OWNER
+
+# nickserv support.
+###set nickServ_pass   PASSWORD
+
+# default quit message.
+set quitMsg            adios amigos
+
+# path to a temporary directory which infobot can use.
+set tempDir            /tmp
+
+#####
+# Factoid database configuration
+#####
+
+# [str] Ability to remember/tell factoids
+#      none    -- disable.
+#      mysql   -- ...
+#      SQLite  -- SQLite (libdbd-sqlite-perl) (might be version 2 or 3)
+#      SQLite2 -- SQLite (libdbd-sqlite-perl) (force version 2)
+#      pgsql   -- postgresql (SUPPORTED and TESTED!!!)
+### REQUIRED by factoids,freshmeat,karma,seen,...
+set DBType             mysql
+
+# [str] SQLite filename prefix // MYSQL/PGSQL database.
+#      eg: infobot-factoids, infobot-seen
+#      eg: /var/db/mysql/infobot/factoids.*
+set DBName             infobot
+
+# [str] Hostname of database server (unset for SQLite)
+set SQLHost            localhost
+
+# [str] SQL user allowed to insert,update,delete stuff from tables. (unset for SQLite)
+set SQLUser            infobot
+
+# [str] SQL password. (unset for SQLite)
+set SQLPass            PASSWORD
+
+# [str] SQL debug file. "-" for stdout may work on some platforms
+###set SQLDebug                SQL_debug.log
+
+#####
+# Logfile configuration
+#####
+
+# [file] where to put logging info. comment out to disable.
+#set logfile           log/$ircUser.log
+set logfile            log/
+
+# [str] Type of logging.
+#   DAILY      -- Create a new log each day.
+#   DEFAULT    -- One continuous log file.
+set logType            DAILY
+
+# [int] Maximum log size, if logfile is defined, in bytes.
+set maxLogSize         10000000
+
+#####
+# Factoid-related configuration
+#####
+
+# [bool] Factoid support.
+set factoids           true
+
+# [days] if not 0, number of days until factoid is deleted for good.
+set factoidDeleteDelay 0
+
+# [int] maximum length of factoid key.
+set maxKeySize         32
+
+# [int] maximum length of factoid value.
+set maxDataSize                450
+
+# [str] when should the bot bother learning new factoids.
+#   ADDRESSED  -- only learn when addressed.
+#   HUNGRY     -- learn irrelevent of addressing. this will catch
+#                 _everything_, use at your own risk.
+set learn              ADDRESSED
+
+# [str] different behaviour with URLs.
+#   REQUIRE    -- means it will need to be a url type (e.g. file:, http:)
+#   OPTIONAL   -- will take anything
+#   REJECT     -- will not accept any urls.  this makes it easy to
+#                 run 2 with different nicks and styles.
+#                 ^^^ what's the point of this???
+set acceptUrl          OPTIONAL
+
+# [bool] profanity checking.
+set profanityCheck     false
+
+# [0/1] tell so-and-so about such-and-such of a factoid.
+set allowTelling       1
+
+# [str] other bots to ask for factoids which they may have.
+#set friendlyBots      url purl script mrapi
+
+#####
+# Factoid related and unrelated features, mainly Extras.
+#####
+
+# [str] addressing is when you name the bot. FIXME:
+#   REQUIRE    -- the bot only does something if addressed.
+#   OPTIONAL   -- the bot responds (does not learn) irrelevent of
+#                 addressing.
+set addressing         REQUIRE
+
+# [str] how the bot should send messages.
+#   PRIVATE    -- reply to private messages only, rejecting public msgs.
+#   DEFAULT    -- reply to public _and_ private queries.
+set talkMethod         DEFAULT
+
+# [str] how long the output string should be before it is changed from
+#      public to private.
+#      "+" before bot commands overrides this option temporarily.
+###set minLengthBeforePrivate 192
+
+# [0/1] allow people outside any channels the bot is on to use the bot
+#      for factoids and commands.
+set disallowOutsiders  1
+
+# [int] Amount of time for auto-ignore (flooding) to expire.
+set ignoreAutoExpire   5
+
+# [int] Amount of time for forced-online ignore to expire. minutes.
+set ignoreTempExpire   60
+
+#####
+# Internal (simple) bot commands
+#####
+
+# [0/1] Forking... disable for non-nix OS or to reduce mem usage.
+#      Disabling should make the bot work on Win32 and MacOS.
+set forking            1
+
+# [int] Backlog... ideal to see what happened to the bot on console.
+#      maximum number of lines to backlog.
+set backlog            24
+
+#####
+# Extra features
+#####
+
+# [str] anything which requires LWP + http proxy.
+###set httpProxy               http://HOSTNAME:PORT/
+
+# [0/1] countdown to specific dates
+set countdown          true
+
+# [0/1] Debian file and package search.
+# FIXME: should be a channel option
+set Debian             true
+
+# [0/1] Freshmeat
+set freshmeat          false
+# [int] how often to update the freshmeat table, in hours.
+set freshmeatRefreshInterval 24
+
+# [bool] if factoid does not exist, check freshmeat for it.
+set freshmeatForFactoid                false
+
+# [0/1] Uptime logs
+set Uptime             true
+
+# [minutes] RSS Feeds refresh interval
+set rssFeedTime         30
+
+#####
+# Miscellaneous configuration options
+#####
+
+# [int] Display a bit too much info about stuff.
+#   0  -- disable.
+#   1  -- standard.
+#   2  -- extra.
+set VERBOSITY          1
+
+# [0/1] Warn messages.
+set WARN               1
+
+# [0/1] Debugging messages.
+set DEBUG              0
+
+# [0/1] Work In Progress...
+set WIP                        0
+
+# strict perl?
+set useStrict          1
+
+# debugging...
+###set DumpVars                1
+###set dumpvarsAtExit  1
+# log to specific file or global log file.
+###set dumpvarsLogFile dumpvars.log
+# more debugging
+###set DumpVars2               1
+###set symdumpLogFile  log/dumpvars2.log
+
+# [str] Interface: [IRC/CLI]
+#   IRC                -- Internet Relay Chat
+#   CLI                -- Command Line Interface
+set Interface          IRC
+
+# [0/1] Show topic author (troubled)
+# If 1, topics managed with !topic add foo will show the nick in ()'s
+# If 0, the nick of the creator will be recorded for !topic list, but not shown in the topic itself
+set topicAuthor 1
+
+####
+# Now modify infobot.chan for per-channel specific configuration see
+# sample.chans for info.
+####