TracNav menu

  1. Install Guide
    1. Installing rbot from a stable tarball
    2. Installing rbot from git
      1. Running it from the git checkout directory
      2. Creating a gem and installing it system-wide
    3. Mac OS X
    4. Debian / Ubuntu
  2. Requirements
    1. BDB
      1. BDB on Win32
    2. OpenSSL
    3. YAML
    4. Gems
    5. rubyful_soup
    6. shorturl
    7. tzinfo

Install Guide

There are two ways to install rbot:

  1. from a stable tarball release
  2. from git (by building a gem, or by running it from the checkout directory)

There are also a number of requirements (Berkeley Database, most importantly) -- see below for instructions on installing those.

Installing rbot from a stable tarball

  • Go to the wiki home page and grab the tarball
  • unpack it
  • run setup.rb to install
  • run rbot

If you want to install to a specific directory, you can run setup like this:

$ setup.rb all --prefix="<path>"

Note that the library files will not be installed to specified prefix, but likely /usr/local/lib/site_ruby/<version> instead. You can specify this directory using the --siterubyver= option.

If you want to install to your home dir, use: 

$ setup.rb all --installdirs=home

(other options for installdirs are std and site)

The libraries are installed to ~/lib/ruby/.

Make sure that the directory where libraries are installed is listed in the RUBYLIB environment variable.

On first run, the bot will ask for whatever configuration is required on first run.

If you want to run multiple configurations, then run rbot.rb ~/.rbot2 or something like that, the first parameter is the location for rbot to store its runtime data in, and it defaults to ~/.rbot.

Installing rbot from git

Follow checkout instruction

Running it from the git checkout directory

After doing the checkout, rbot will be living in a directory called rbot. If you want to run it from there without installing it onto your system, just do this: 

$ cd rbot
$ ruby launch_here.rb

And that's it! You're up and running! (Of course, now the only people who can use rbot are those who can access that rbot directory.)

Rbot supports Internationalization; messages from rbot as well as plugins can be translated into your language. To use this feature, it is necessary to compile provided translation into "machine objects". This step is only needed for running rbot from a git directory. It requires rake and ruby-gettext. 

$ rake makemo

Creating a gem and installing it system-wide

To create a gem, all you have to do is run 'rake' in the rbot directory. This will create a gem in the pkg subdirectory (the file will be called rbot-<version>.gem). You can then install it directly using "gem".

Example: 

$ cd rbot
$ rake
$ cd pkg
$ gem install rbot-0.9.11.gem

Note: If you don't have rake on your system, you'll need to install the gem. Just run gem install rake. If you don't have gem, you should go to rubygems.org''

Other Note: Running Rake on Win32 platforms (Windows 95/98/ME/2000/XP) needs some Unix-style command line programs, so if rake fails try installing the MSYS toolkit.

If you have ruby-gettext installed, gem will automatically set up translation files.

Mac OS X

How to make rbot work on Mac OS X

Debian / Ubuntu

Debian / Ubuntu Installation Guide

Requirements

BDB

rbot needs bdb to store cross-session data for itself and its plugins. BDB 4.4 or lower is required, as the Ruby BDB bindings are not compatible with the new 4.5.

BDB on Win32

The latest precompiled version of bdb for Ruby on Win32 is available at http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ext/bdb-0.5.1-i386-mingw32-1.8.tar.gz.

Note that even though the binary was built against the mingw32 version fo Ruby (http://ftp.ruby-lang.org/pub/ruby/binaries/mingw/1.8/ruby-1.8.4-i386-mingw32.tar.gz) it can be used on the mswin32 version as well, without any additiona library (which was the case with Ruby 1.6 instead). In particular, it can be used with the One-Click Ruby Installer for Windows. A ticket has been opened asking for inclusion of bdb in the One-Click Ruby Installer for Windows. If they add it, there won't be any need for additional packages.

After you get the bdb tarball, you need to unpack it somewhere, and then move the files in the appropriate location. You'll notice that the tarball contains a single folder usr, with a single subfolder local, which contains two folders, doc and lib}}. You have to move these folders into the directory where you installed Ruby (typically, {{{c:\ruby with the One-Click Ruby Installer for Windows)

OpenSSL

rbot has an http access library used by many plugins. This library relies on the OpenSSL library to access https resuources. The OpenSSL library will also be used in versions from 0.9.11 onwards for protected IRC connections (see [558]).

On Windows, the One-Click Ruby Installer for Windows comes with OpenSSL.

On Linux, you might have to install additional libraries or packages. For Debian it's the libopenssl-ruby package.

YAML

Some of the rbot configuration data is stored using YAML

Gems

Although Ruby Gems is not a requirement, it's highly recommended to have it available. Please note that there are some issues about it.

rubyful_soup

Older version of the urban dictionary plugin require rubyful_soup, which you can install via Gem. rubyful_soup is not required anymore since [503]

shorturl

The rubyurl and tinyurl plugins require shorturl. You can install it via Gem.

tzinfo

The time plugin requires tzinfo. You can install it via Gem.