~dennis/ubot/trunk

« back to all changes in this revision

Viewing changes to ubotweb/doc/content/install.txt

  • Committer: Dennis Kaarsemaker
  • Date: 2008-04-06 16:29:36 UTC
  • Revision ID: dennis@blackbird-20080406162936-90n5fz80da8nvzks
* Moar docs!
* Add roundup support to Bugtracker

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
Installing µbot
 
2
---------------
 
3
µbot is not a bot for scriptkiddies. It takes a bit of effort to install and
 
4
does not yet come in a nice installation package. It's also not a click-and go
 
5
solution and does not have a 'config wizard'.  But if you're prepared to follow
 
6
this guide you will end up with one of the best IRC bots since sliced bread.
 
7
 
 
8
Prerequisites
 
9
-------------
 
10
Since µbot does not yet come with nice install packages, you will need to
 
11
install any prerequisites yourself. You will need the following software:
 
12
 
 
13
* Python 2.5
 
14
* DBus and dbus-python
 
15
* django
 
16
* pytz
 
17
* chardet
 
18
* pygtk (only the gobject bits are needed)
 
19
* mysql and python-MySQLdb (you could use sqlite or postgres as well)
 
20
* python-apt
 
21
* bzr
 
22
 
 
23
If you use Ubuntu, you can install all these packages with the following
 
24
command: ::
 
25
 
 
26
 sudo apt-get install python2.5 dbus python-dbus python-django python-tz \
 
27
                      python-chardet python-gobject mysql-server-5.0 \
 
28
                      python-mysqldb python-apt bzr
 
29
 
 
30
Downloading the code
 
31
--------------------
 
32
The code is hosted at launchpad.net, where development is coordinated. To
 
33
download the code, you need to use ``bzr``. The follwing command will create
 
34
a copy of the µbot sourcecode in a directory called ``ubot``. ::
 
35
 
 
36
 bzr branch lp:ubot ubot
 
37
 
 
38
To update the code to the latest version, you can use the following command
 
39
in the newly created ``ubot`` directory ::
 
40
 
 
41
 bzr pull lp:ubot
 
42
 
 
43
Since µbot is written in python, it does not need to be compiled. Installation
 
44
is already complete.
 
45
 
 
46
Configuring the bot
 
47
-------------------
 
48
Since µbot is fairly simple, configuring it is a breeze. There are only a few
 
49
variables to set. For a simple setup without failover, the following is enough ::
 
50
 
 
51
 [me]
 
52
 nick1    = ubot
 
53
 nick2    = ubot2
 
54
 nick3    = ubot2
 
55
 ident    = ubot
 
56
 realname = Ubot
 
57
 server1  = irc.freenode.net
 
58
 password = Secret
 
59
 
 
60
There is no limit to the number of nicks or servers  you can define, just make
 
61
sure they have consecutive, increasing numbers.  Place this in
 
62
``~/.ubot/<busname>/config`` (replace <busname> with something alpanumeric
 
63
that's similar to the bots nickname).