Commit f3599933 authored by Aaron Wells's avatar Aaron Wells

Adding setup instructions for it

parent 9e35e773
How to set up SupyBot & MeetBot
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.
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.
1. Install SupyBot via apt
sudo apt-get install supybot
2. Build and install MeetBot python libraries
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
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")
supybot-adduser -u USERNAME -p PASSWORD -c owner
4. Copy mahara-meetbot.conf-dist to mahara-meetbot.conf
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:
supybot.nick: The IRC nickname of the robot
6. Launch supybot.
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.
(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
9. Check that the meeting logs are present
cd $SUPYBOT_HOME
cd maharameet-test
# 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
......@@ -5,6 +5,13 @@
###
supybot.nick: maharameet-test
###
# Determines what channels the bot will join only on freenode.
#
# Default value:
###
supybot.networks.freenode.channels: ##maharameet-test #mahara-dev
###
# Determines what alternative nicks will be used if the primary nick
# (supybot.nick) isn't available. A %s in this nick is replaced by the
......@@ -58,13 +65,6 @@ supybot.networks.freenode.password:
###
supybot.networks.freenode.servers: 82.96.64.4:6667
###
# Determines what channels the bot will join only on freenode.
#
# Default value:
###
supybot.networks.freenode.channels: ##maharameet-test #mahara-dev
###
# Determines what key (if any) will be used to join the channel.
#
......
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