Commit 05311e89 authored by Aaron Wells's avatar Aaron Wells

Updating README into markdown, and adding the gitsubmodule step

parent bb572745
How to set up SupyBot & MeetBot
## MeetBot for Mahara
The "MeetBot" that we use during Mahara developer meetings, is actually
a plugin to the "SupyBot" IRC bot. Running it requires installing SupyBot,
building and installing MeetBot, configuring both of them, creating a
set of directories in a particular structure, and then launching the bot.
This repository contains the configuration and directory skeleton needed to run
MeetBot for logging the minutes of [Mahara developer
meetings](https://wiki.mahara.org/wiki/Developer_Area/Developer_Meetings).
0. Clone this repo. For the purposes of this install, I'll refer to your
install location as $SUPYBOT_HOME, but you DON'T specifically need to set
up a variable with this name.
Specifically, [MeetBot](http://meetbot.debian.net/Manual.html) is a plugin of
the IRC bot program [SupyBot](http://supybook.fealdia.org/devel/). Mahara's
usage of it is modeled after its usage by [the Debian
project](https://wiki.debian.org/MeetBot).
## How to set up SupyBot & MeetBot
To run MeetBot, you must first install Supybot, build and install MeetBot,
configure both of them, place them in a particularly structured set of
directories, and then launch the bot. This repository contains the necessary
configuration file, directories, and a gitsubmodule for the MeetBot code.
SupyBot can be obtained via an `apt` package.
0. Clone this repo. For documentation purposes, I'll refer to the location
where you've cloned this repo as `$SUPYBOT_HOME`, but you **don't**
specifically need to set up a shell variable with this name.
1. Install SupyBot via apt
sudo apt-get install supybot
````
sudo apt-get install supybot
````
2. Check out the MeetBot code via the git submodule
````
cd $SUPYBOT_HOME
git submodule update --init
````
2. Build and install MeetBot python libraries
cd $SUPYBOT_HOME/meetbot-plugin
python setup.py build
sudo python setup.py install
````
cd $SUPYBOT_HOME/meetbot-plugin
python setup.py build
sudo python setup.py install
````
3. (While supybot is NOT running) Add yourself as supybot's owner using
the "supybot-adduser" script which was include in the apt package. The
the `supybot-adduser` script which was include in the apt package. The
username and password here don't need to match up with any usernames or
passwords in IRC or elsewhere. (But the -c does need to be "owner")
passwords in IRC or elsewhere. (But the `-c` does need to be `owner`)
````
cd $SUPYBOT_HOME
supybot-adduser -u USERNAME -p PASSWORD -c owner
````
supybot-adduser -u USERNAME -p PASSWORD -c owner
4. Copy "mahara-meetbot.conf-dist" to "mahara-meetbot.conf"
4. Copy mahara-meetbot.conf-dist to mahara-meetbot.conf
````
cd $SUPYBOT_HOME
cp mahara-meetbot.conf-dist mahara-meetbot.conf
(You should see logs there, sorted by time)
````
5. Take a glance through mahara-meetbot.conf and see if you want to change
anything. Most likely you will just want to change this one:
5. Take a glance through "mahara-meetbot.conf" and see if you want to change
anything. Most likely you will just want to change this one, at the top:
supybot.nick: The IRC nickname of the robot
````
supybot.nick: The IRC nickname of the robot
````
6. Launch supybot.
cd $SUPYBOT_HOME
supybot mahara-meetbot.conf
````
cd $SUPYBOT_HOME
supybot mahara-meetbot.conf
````
7. You should now see your supybot present in the channels #mahara-dev
and ##maharameet-test. You can identify yourself to it as its owner,
using the credentials you set up with supybot-adduser in step 3. Open
a direct dialogue with it, and use the "identify" command.
7. On irc.freenode.net, you should now see your supybot present in the channels
`#mahara-dev` and `##maharameet-test`. You can identify yourself to it as its
owner, using the credentials you set up with `supybot-adduser` in step 3. Open
a direct dialogue with it, and use the `identify` command.
(in IRC)
/query <name of bot>
(in dialog with bot)
identify <username> <password>
````
(in IRC)
/query <name of bot>
(in dialog with bot)
identify <username> <password>
````
If it works, the bot will say to you "The operation succeeded."
8. Test the meeting startup.
(in the ##maharameet-test IRC channel, while bot is present)
#startmeeting This is my test meeting
#info This is an informational bullet point
#agree We agree on this
#endmeeting
````
(in the ##maharameet-test IRC channel, while bot is present)
#startmeeting This is my test meeting
#info This is an informational bullet point
#agree We agree on this
#endmeeting
````
9. Check that the meeting logs are present
cd $SUPYBOT_HOME
cd maharameet-test
# You should see logs there, sorted by time
````
cd $SUPYBOT_HOME/maharameet-test
ls
(You should see logs there, sorted by time)
````
10. You can turn off meetbot by hitting "Control-C" in the terminal.
\ No newline at end of file
10. To turn off meetbot, you'll need to kill it by hitting "Control-C" in the
terminal where you launched it.
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment