tags/0.4.3.1-pre2/README

   1         SurrealServices is a full replacement for services like
   2 Auspice or Anope, offering NickServ, ChanServ, MemoServ,
   3 BotServ, OperServ. But it is more than that, it also has a
   4 plugin/module system akin to NeoStats. Additionally it is
   5 multithreaded to eliminate the problems with timers not expiring
   6 properly as well as not block everything on a complex or slow
   7 database query.
   8
   9 You can contact us on irc.surrealchat.net #dev.lounge or via email:
  10 tabris@surrealchat.net or saturn@surrealchat.net
  11
  12 -----------------------------------------------------------------------
  13 CONFIGURATION TIPS
  14
  15 SrSv does not support ziplinks nor SSL, so it should be hosted on the
  16 same box as the hub, or at least the same local network.
  17
  18 -----------------------------------------------------------------------
  19 NUMBER OF PROCESSES
  20
  21 We recommend that you leave the "procs" setting at 4 for
  22 uniprocessor and dual processor servers.  Our benchmarks have
  23 shown that increasing it above 4 does not provide any benefit.
  24
  25 You may set "procs" to 0 for use on shell servers with a
  26 limit on the number of background processes. Be aware that
  27 certain SecurityBot features may cause unacceptable lag when
  28 running in single-process mode. This issue will be fixed in a
  29 future release.
  30
  31 -----------------------------------------------------------------------
  32 MODULE CONFIGURATION
  33
  34 "country" must be loaded AFTER services, and requires that you run
  35 country-table.pl before using it.
  36
  37 We recommend you run country-table.pl daily in crontab.
  38
  39 "geoip" is like country, but:
  40 a) a much larger set of tables.
  41 b) should not be loaded with country.
  42 c) requires utils/geoip.pl to be run at least once.
  43 d) Don't bother running geoip.pl more often than monthly in a crontab.
  44 e) the datafiles are generally updated on the first of the month
  45 f) geoip uses GeoLite City from MaxMind. We do not grant you a license to use it
  46    and are not responsible for any consequences of your using it.
  47