This document will get you up and running with Gozerbot.
Being a Python bot, Gozerbot requires Python to run. Gozerbot will work properly with any Python version 2.4 and higher.
You can obtain Python from: 1. Python 2. Debian: apt-get install python 3. FreeBSD: cd /usr/ports/lang/python ; make 3. ArchLinux: pacman -S python
If you plan to use Gozerbot with a MySQL database backend, you need to setup a database for Gozerbot first. Connect to your database as root, and setup the proper privlieges:
mysql> CREATE DATABASE gozerbot; Query OK, 1 row affected (0.00 sec)
- mysql> GRANT ALL ON gozerbot.* TO 'gozerbot'@'localhost‘
- -> IDENTIFIED BY ‘s3cr3t’;
Query OK, 0 rows affected (0.00 sec)
mysql> FLUSH PRIVILEGES; Query OK, 0 rows affected (0.00 sec)
There are several ways of installing Gozerbot. Some distributions may have Gozerbot packaged which we will not cover in this document. Refer to the documentation of your package manager on how to obtain Gozerbot in your distribution.
For all other distributions or operating systems, you can get Gozerbot in a few different flavours.
You can download a stable tarball version from our main site. The download file will be named gozerbot-0.x.y.z.tar.gz, where:
- major version
- minor version
- patch level (bugfix releases)
Once your have downloaded the tarball successfully, extract the tarball:
$ gunzip -c gozerbot-0.x.y.z.tar.gz | tar -xvf - gozerbot-0.x.y.z/ .... $
You can download a beta or preview version using Mercurial. The advantage of running beta code is, that you can UPGRADE ON THE FLY, using the !upgrade command. To download the current version, use:
$ hg clone http://www.gozerbot.org/hg/gozerbot/ destination directory: gozerbot requesting all changes adding changesets adding manifests adding file changes added 1840 changesets with 3824 changes to 459 files 308 files updated, 0 files merged, 0 files removed, 0 files unresolved $
Once you have downloaded the code, you can install the code site-wide, if you for example prefer to run multiple Gozerbot instances.
You can perform a local installation using:
$ cd gozerbot/ # or gozerbot-0.x.y.z $ python setup.py install –prefix /home/users/joe ...
You can perform a global installation using:
$ cd gozerbot/ # or gozerbot-0.x.y.z $ python setup.py build $ sudo python setup.py install ...
Change to the working directory you wish to run Gozerbot from. If you don’t have a working directory yet, create one.
$ mkdir mybot $ cd mybot/
Now you can call gozerinit to setup your bot. If you did not do a local or global installation, running the bot from the directory you downloaded Gozerbot in, use bin/gozerinit
$ gozerinit $ ls gozerdata $
You’re almost done now! The last thing you will have to do, is editing the gozerdata/config file. The most important settings are:
Flag Description owneruserhost This is your exact hostmask, in the form: ident@hostname.tld The bot uses this to identify you as owner on IRC. nick The nickname of your Gozerbot. server The server your Gozerbot will connect to.
If you wish to use MySQL as your database backend, you will also have to configure:
Flag Description dbenable Set this to 1 if you want to enable the database. dbtype Currently only MySQL is considered stable, you can use this by entering mysql here. dbhost The host of your database, use localhost to connect to your database using the default UNIX socket. dbuser The username that is allowed to connect to the database. dbpasswd The password used for connecting to the database. dbname The name of the database you are going to use. dboldstyle Set to True if your MySQL version is older than 4.1
All you have to do, is starting the bot with the gozerbot command. If you did not do a local or global installation, running the bot from the directory you downloaded Gozerbot in, use ./runbot.