Ansible Hubot

This is an Ansible role for Hubot, the wonderful chatting robot that is sure to bring your team much delight and various values of increased productivity throughout the livelong day!

By default this Hubot is configured for HipChat, but that can be easily changed by editing defaults/main.yml, updating the value of hubot_adapter, and adding the appropriate environment variables to templates/hubot.env.j2.

Requirements

This Hubot role requires a Debian based Linux host and has been tested to function on Ubuntu with the following specific software versions:

Ansible: 1.7
Hubot: GitHub Master
Node.js: 0.10.31
Ubuntu: 13.10, 13.04, 12.10, 12.04

Role Variables

All variables are specified in defaults/main.yml and vars/main.yml.

Defaults

Name	Default Value	Description
hubot_adapter	hipchat	Specify preferred chat adapter to use
hubot_admin	vagrant	OS username of Hubot owner/admin
hubot_dir	`/home/<hubot_admin>/hubot`	The Hubot base directory
hubot_identity	hubot	The bot's identity or short username
hubot_os_packages	List	List of OS dependency packages to install
hubot_node_version	0.10.25	Preferred Node.js version
hubot_node_packages	List	List of Node.js dependency packages to install
hubot_nvm_dir	/home/{{ hubot_admin }}/nvm	Directory for Node Version Manager (nvm) installation
hubot_node_dir	{{ hubot_nvm_dir }}/v{{ hubot_node_version }}/bin	Directory for Node.js installation
hubot_src_dir	/home/{{ hubot_admin }}/src/hubot	Directory for Hubot source code

The following Node.js dependency packages are defined in hubot_node_packages and installed by default to support the additional Hubot scripts included in this role:

cleverbot-node
htmlparser
nodepie
soupselect
hubot-hipchat
hubot-scripts

If you add more Hubot scripts to the list defined in the Variables section, be sure to add any Node.js dependencies required by the scripts to the hubot_node_packages list as well.

The following OS dependency packages are defined in hubot_os_packages and installed by default:

build-essential
curl
git-core
libssl-dev
libexpat1-dev
redis-server

Most of these packages are required with the exception of redis-server, which is a dependency of the Hubot redis-brain script.

Variables

Name	Default Value	Description
hubot_scripts	List	A list of additional Hubot scripts to use

The following relatively conservative additional Hubot scripts befitting something akin to an Engineering team are defined in hubot_scripts as part of vars/main.yml and installed by default:

achievement_unlocked.coffee
ackbar.coffee
applause.coffee
ascii.coffee
base64.coffee
bees.coffee
botsnack.coffee
cat.coffee
cleverbot.coffee
coin.coffee
cowsay.coffee
dealwithit.coffee
decide.coffee
fortune.coffee
github-status.coffee
grumpycat.coffee
hackernews.coffee
megusta.coffee
penny-arcade.coffee
ping.coffee
redis-brain
reddit
reddit-jokes.coffee
reddit-random-top.coffee
remind.coffee
shipit.coffee
stallman.coffee
twss
wunderground.coffee
xkcd.coffee
zombies.coffee

Feel free to remove or add scripts to your heart's content.

Configuration

At a minimum, modify the variables defined in the following files as necessary:

defaults/main.yml
vars/main.yml

Then, copy templates/hubot.env.j2 to templates/_hubot.env.j2 and update as necessary with the particular environment variables you need for your Hubot.

Copy hosts.example to hosts and edit it to update the values for your Hubot host. Be sure to change the following values:

0.0.0.0
ubuntu
~/.ssh/hubot_id

Finally, update the site.yml playbook if you plan to use it and set hubot_identity to the short username of your bot.

Example Playbook

After configuration a basic Hubot installation and activation is possible using the included site.yml playbook:

ansible-playbook -i hosts site.yml

Dependencies

None

License

Apache 2

Author Information

Brian Shumate

stevenscg / ansible-hubot