How do I set up an Eridanus bot from scratch?

Created by Tristan Seligmann on on 2010-05-07
Keywords:
Last updated by:
Tristan Seligmann on on 2010-05-10

Note that installing Eridanus and its dependencies is beyond the scope of this FAQ.

Initial setup:

$ axiomatic -d bot.axiom mantissa
Enter Divmod™ Mantissa™ password for 'admin@localhost':
Confirm Divmod™ Mantissa™ password for 'admin@localhost':
$ axiomatic -d bot.axiom offering install Eridanus

You can use whatever you want for the service ID, just remember to use the same value in the other commands.

$ axiomatic -d bot.axiom eridanus service create --id=testbot
$ axiomatic -d bot.axiom eridanus service config --id=testbot --name=Shadowfire --host=za.shadowfire.org --nick=Testy --channels="#testy"
$ axiomatic -d bot.axiom eridanus plugins install Authenticate

Create a user we can use to admin the bot over IRC:

$ axiomatic -d bot.axiom userbase create mithrandi testbot
Enter new AXIOM password:
Repeat to verify:
$ axiomatic -d bot.axiom eridanus plugins grant mithrandi testbot Admin

Start the bot (you can leave off -n to allow it to daemonize):

$ axiomatic -d bot.axiom start -n
2010-05-07 17:15:43+0200 [-] Log opened.
2010-05-07 17:15:43+0200 [-] twistd 10.0.0 (/usr/bin/python 2.5.5) starting up.
...snip...
2010-05-07 17:15:43+0200 [-] Connecting to Shadowfire (za.shadowfire.org:6667) as u'Testy'
2010-05-07 17:15:43+0200 [-] Starting factory <eridanus.bot.IRCBotFactory instance at 0x375d170>
2010-05-07 17:15:44+0200 [IRCBot,client] Signed on.
2010-05-07 17:15:44+0200 [IRCBot,client] Joined channels: [u'#testy']

You can now log in by messaging the bot:

<mithrandi> auth login passwordgoeshere
<Testy> mithrandi: Successfully authenticated.