1) Download

Use your operating system installer to download Guppy on these systems:

* Archlinux
* Windows (coming soon)

Alternatively, use wget to download guppy over http, or git.

* (git instructions coming soon)

2) Directory structure

After downloading guppy, the directory structure will be similar to something like this:

    conf/
    dist/
    extra/
    guppy
    irc.py
    plugins/
    README

The extra/ directory contains plugins that are either unfinished or very specific, you will usually not need them. (You can put them in plugins/ before running the install script, if you need them, but do please read them first if you decide to do so.)

The dist/ directory contains installation scripts for supported operating systems.

3) Configuration

Run the guppy executably once to launch the installer script.

   $ ./guppy

It will prompt you with a list of plugins. Choose carefully, the default is minimal!


    $ ./guppy

      __ _ _   _ _ __  _ __  _   _
     / _` | | | | '_ \| '_ \| | | | http://repo.or.cz/w/guppy.git/summary
    | (_| | |_| | |_) | |_) | |_| | irc://irc.freenode.net/guppy
     \__, |\__,_| .__/| .__/ \__, | http://guppy.uk.to
     |___/      |_|   |_|    |___/  version 0.4.4
     
    Settings directory: /home/test/tests/ircd/guppy/conf/
    No configuration file found, running makeconf
    What IRC network do I connect to (just the name)? []: gnu
    What is the IRC network address (eg. irc.example.org)? []: irc.gnu.org
    What channels to automatically join (comma-separated, no spaces)? []: #bots
    What nickname should I use? []: 
    ...

4) Running in background

After the configuration, the binary will exit, and you will need to start it again in screen or tmux with no arguments; guppy does not fork into the background.

   $ screen -U ./guppy

or

   $ tmux ./guppy


5) Authentication

Once the bot joins the channel, if you loaded auth plugin, you will need to set up your password. Otherwise anyone who uses your nickname can control the bot. Use the "passwd" command in PM with the bot to set a new password.

    <rob> passwd lam3r lam3r
    <bot> Password successfully changed.