# README
#
#

welcome to GOZERBOT ;] see http://code.google.com/p/gozerbot

- you need python 2.4 or higher

- if you want jabber support install:

  xmpppy .. see http://xmpppy.sourceforge.net/

  debian: apt-get install python-xmpp

- you can run the bot from the source dir (no root needed) or do a global 
  install of the bot:

  run as root "python setup.py install"

these steps you must do to get the bot running:

0) best is to make a separate user for the bot

if you are in the source dir:

1) run "bin/gozerinit ." .. this will make a gozerdata dir and config file
2) edit gozerdata/config
3) start the bot with "bin/gozerbot"
4) if you want to run the bot as a daemon do "bin/gozerbot >> log 2>&1 &"

otherwise:

1) run "gozerbot-start" .. this will run a bot in ~/.gozerbot .. you
   can provide a directory argument if you want to run the bot in another
   directory

next:

- on first startup the bot doesn't join any channels, you will have to
  /msg thebot join #channel .. the bot wil remember channels it has joined
- you can use the "meet <nick>" command to add other users to the bot

we are on #dunkbots ircnet

MAKE REGULAR BACKUPS OF YOUR BOT DIRECTORY

see doc/BASIC for basics of the bot and doc/OPER for maintenance

database support:

- if you want mysql support install:

  MySQLdb .. see http://sourceforge.net/projects/mysql-python/

  since we use utf-8 now mysql version 5 is required for non ascii users
  
  1) create the bot database in mysql:
     CREATE DATABASE gb_db;
  2) once you've done that add mysql access rules for the bot user:
     GRANT ALL PRIVILEGES ON gb_db.* TO user@host IDENTIFIED by 'pass';
     FLUSH PRIVILEGES;
  3) init the database:
     mysql -p gb_db <  files/gb_db

- if you want sqlite support install:

  pysqlite .. see http://initd.org/tracker/pysqlite

  1) sqlite botdir/gozerdata/dbname < files/sqlite_db .. if you run sqlite 
     version2 .. use sqlite3 client if you use version3

- if you want postgresql support install:

  psycopg2 .. see http://www.initd.org/pub/software/psycopg/

  1) createuser -E -P -D -R -S gozerbot -h localhost
  2) createdb -O gozerbot gb_db
  3) psql gb_db < files/postgres_db
